Skip to content
This repository was archived by the owner on Apr 14, 2025. It is now read-only.
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
The diff you're trying to view is too large. We only load the first 3000 changed files.
41 changes: 0 additions & 41 deletions .github/workflows/update-doc-version.yaml

This file was deleted.

4 changes: 2 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,5 @@ _site
.jekyll-cache
.jekyll-metadata
vendor

.codegpt
.codegpt
tmp/
1,616 changes: 0 additions & 1,616 deletions 2-day-cdd-workshop/index.html

This file was deleted.

1,723 changes: 0 additions & 1,723 deletions 2-week-signup/index.html

This file was deleted.

913 changes: 0 additions & 913 deletions 404/index.html

This file was deleted.

1 change: 0 additions & 1 deletion CNAME

This file was deleted.

57 changes: 0 additions & 57 deletions Features.md

This file was deleted.

28 changes: 0 additions & 28 deletions Gemfile
Original file line number Diff line number Diff line change
@@ -1,31 +1,3 @@
source "https://rubygems.org"

gem "jekyll"

# plugins
gem "jekyll-feed"
# gem "jekyll-include-cache"
gem "jekyll-mermaid"
gem "jekyll-seo-tag"
gem "jekyll-sitemap"
gem "jekyll-tabs"
gem "rouge"
gem "jekyll-redirect-from"

# other stuff needed by jekyll
gem "kramdown-parser-gfm"
gem "sass-embedded"
gem "webrick"

# theme
gem "just-the-docs"

# to validate links
gem "html-proofer"


platforms :mingw, :x64_mingw, :mswin, :jruby do
gem "tzinfo", ">= 1", "< 3"
gem "tzinfo-data"
end
gem "wdm", "~> 0.1.1", :platforms => [:mingw, :x64_mingw, :mswin]
92 changes: 0 additions & 92 deletions Gemfile.lock
Original file line number Diff line number Diff line change
@@ -1,30 +1,16 @@
GEM
remote: https://rubygems.org/
specs:
Ascii85 (2.0.1)
addressable (2.8.7)
public_suffix (>= 2.0.2, < 7.0)
afm (0.2.2)
async (2.23.1)
console (~> 1.29)
fiber-annotation
io-event (~> 1.9)
metrics (~> 0.12)
traces (~> 0.15)
base64 (0.2.0)
bigdecimal (3.1.9)
colorator (1.1.0)
concurrent-ruby (1.3.5)
console (1.30.2)
fiber-annotation
fiber-local (~> 1.1)
json
csv (3.3.3)
em-websocket (0.5.3)
eventmachine (>= 0.12.9)
http_parser.rb (~> 0)
ethon (0.16.0)
ffi (>= 1.15.0)
eventmachine (1.2.7)
ffi (1.17.1-aarch64-linux-gnu)
ffi (1.17.1-aarch64-linux-musl)
Expand All @@ -34,10 +20,6 @@ GEM
ffi (1.17.1-x86_64-darwin)
ffi (1.17.1-x86_64-linux-gnu)
ffi (1.17.1-x86_64-linux-musl)
fiber-annotation (0.2.0)
fiber-local (1.1.0)
fiber-storage
fiber-storage (1.0.0)
forwardable-extended (2.6.0)
google-protobuf (4.30.2)
bigdecimal
Expand All @@ -54,20 +36,9 @@ GEM
google-protobuf (4.30.2-x86_64-linux)
bigdecimal
rake (>= 13)
hashery (2.1.2)
html-proofer (5.0.10)
addressable (~> 2.3)
async (~> 2.1)
nokogiri (~> 1.13)
pdf-reader (~> 2.11)
rainbow (~> 3.0)
typhoeus (~> 1.3)
yell (~> 2.0)
zeitwerk (~> 2.5)
http_parser.rb (0.8.0)
i18n (1.14.7)
concurrent-ruby (~> 1.0)
io-event (1.10.0)
jekyll (4.4.1)
addressable (~> 2.4)
base64 (~> 0.2)
Expand All @@ -87,29 +58,13 @@ GEM
safe_yaml (~> 1.0)
terminal-table (>= 1.8, < 4.0)
webrick (~> 1.7)
jekyll-feed (0.17.0)
jekyll (>= 3.7, < 5.0)
jekyll-include-cache (0.2.1)
jekyll (>= 3.7, < 5.0)
jekyll-mermaid (1.0.0)
jekyll-redirect-from (0.16.0)
jekyll (>= 3.3, < 5.0)
jekyll-sass-converter (3.1.0)
sass-embedded (~> 1.75)
jekyll-seo-tag (2.8.0)
jekyll (>= 3.8, < 5.0)
jekyll-sitemap (1.4.0)
jekyll (>= 3.7, < 5.0)
jekyll-tabs (1.2.1)
jekyll (>= 3.0, < 5.0)
jekyll-watch (2.2.1)
listen (~> 3.0)
json (2.10.2)
just-the-docs (0.10.1)
jekyll (>= 3.8.5)
jekyll-include-cache
jekyll-seo-tag (>= 2.0)
rake (>= 12.3.1)
kramdown (2.5.1)
rexml (>= 3.3.9)
kramdown-parser-gfm (1.1.0)
Expand All @@ -119,41 +74,15 @@ GEM
rb-fsevent (~> 0.10, >= 0.10.3)
rb-inotify (~> 0.9, >= 0.9.10)
mercenary (0.4.0)
metrics (0.12.2)
nokogiri (1.18.7-aarch64-linux-gnu)
racc (~> 1.4)
nokogiri (1.18.7-aarch64-linux-musl)
racc (~> 1.4)
nokogiri (1.18.7-arm-linux-gnu)
racc (~> 1.4)
nokogiri (1.18.7-arm-linux-musl)
racc (~> 1.4)
nokogiri (1.18.7-arm64-darwin)
racc (~> 1.4)
nokogiri (1.18.7-x86_64-darwin)
racc (~> 1.4)
nokogiri (1.18.7-x86_64-linux-gnu)
racc (~> 1.4)
nokogiri (1.18.7-x86_64-linux-musl)
racc (~> 1.4)
pathutil (0.16.2)
forwardable-extended (~> 2.6)
pdf-reader (2.14.1)
Ascii85 (>= 1.0, < 3.0, != 2.0.0)
afm (~> 0.2.1)
hashery (~> 2.0)
ruby-rc4
ttfunk
public_suffix (6.0.1)
racc (1.8.1)
rainbow (3.1.1)
rake (13.2.1)
rb-fsevent (0.11.2)
rb-inotify (0.11.1)
ffi (~> 1.0)
rexml (3.4.1)
rouge (4.5.1)
ruby-rc4 (0.1.5)
safe_yaml (1.0.5)
sass-embedded (1.86.3-aarch64-linux-gnu)
google-protobuf (~> 4.30)
Expand All @@ -173,15 +102,8 @@ GEM
google-protobuf (~> 4.30)
terminal-table (3.0.2)
unicode-display_width (>= 1.1.1, < 3)
traces (0.15.2)
ttfunk (1.8.0)
bigdecimal (~> 3.1)
typhoeus (1.4.1)
ethon (>= 0.9.0)
unicode-display_width (2.6.0)
webrick (1.9.1)
yell (2.2.2)
zeitwerk (2.7.2)

PLATFORMS
aarch64-linux
Expand All @@ -198,22 +120,8 @@ PLATFORMS
x86_64-linux-musl

DEPENDENCIES
html-proofer
jekyll
jekyll-feed
jekyll-mermaid
jekyll-redirect-from
jekyll-seo-tag
jekyll-sitemap
jekyll-tabs
just-the-docs
kramdown-parser-gfm
rouge
sass-embedded
tzinfo (>= 1, < 3)
tzinfo-data
wdm (~> 0.1.1)
webrick

BUNDLED WITH
2.5.18
1 change: 0 additions & 1 deletion Proxy Diagrams.drawio

This file was deleted.

34 changes: 12 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,16 @@
# Specmatic Documentation

Documentation for [Specmatic](//specmatic.in)
Documentation for [Specmatic](https://specmatic.io)

Dev Setup
* Install Ruby > 2.7 - Preferably with rbenv
* Run ```bundle``` to install dependencies
* Run ```bundle exec jekyll serve``` to start server on localhost:4000

Dev Containers (Recommended Approach)
* Pre-requisites - Docker Desktop
* Visual Studio Code 3
* Open Project in VSCode
* VSCode will ask you install necessary extensions and open in dev container. If not install "Visual Studio Code Remote - Containers" - https://code.visualstudio.com/docs/remote/containers
* The Terminal inside VSCode is mapped to Docker Container. Run below commands in that terminal.
* ```bundle``` to install dependencies
* ```bundle exec jekyll serve``` to start server
* Click on the "localhost:4000" link in terminal to launch it in browser at the ephemeral port
* On my machine it is forwarded to localhost:4001
* You can even push to GitHub inside this terminal because Dockerfile maps your keys

Reference - How to DevContainers for the first time for Jekyll Projects
* Cmd + Shift + P and run ```Remote-Containers: Add Development Container Configuration Files...```
* Search for Jekyll and Choose bullseye
* This will add the .devcontainers folder with necessary configs, re-open project in container
## Workflow

* Download the zip file from wordpress
* Copy the zip file to `tmp/website.zip`
* Execute the following code:
```shell
git pull --rebase
rake all # to clean up the entire contents, unpack the new website, and setup redirects
git add .
git commit -m 'Your commit message'
git push
```
Loading