How continuous-architecture/toolkit works
Project Type & Purpose
• This is an open-source documentation toolkit and static website project (“Continuous Architecture Toolkit”).
• It packages:
• A Jekyll-based landing site (landing/) with Asciidoctor-generated content and Tailwind CSS.
• A reusable style library (stylesheet-factory/) for building custom stylesheets (Sass → CSS).
• Supporting assets (presentations, meta-models, Miro files) under Assets/, meta-model/, miro/.
• Continuous Integration/Deployment via GitHub Actions pushes static site builds to an S3 bucket.
File Structure Analysis
• Top-level directories:
• .github/ → CI workflows (adoc-build-push_s3.yml, jekyll-build-push-S3-v2.yml).
• landing/ → Jekyll site source (Ruby, Markdown/Asciidoc content, Tailwind CSS config).
• stylesheet-factory/ → Sass code, build scripts, Node/Ruby tooling to compile themes.
• governance/, img/, root README, LICENSE, etc.
• Key build tools/config:
• Gemfile → Jekyll + Asciidoctor gems
• package.json/postcss.config.js/tailwind.config.js → Node, PostCSS, Tailwind
• Sass entrypoints in stylesheet-factory/sass/
README Insights
• Local dev requires Ruby, NodeJS/NVM, Yarn, Bundler.
• Build steps:
• bundle install, npm install, yarn add tailwindcss
• JEKYLL_ENV=production jekyll build | serve
• Hosting on S3 via GitHub Actions.
a. Main Components
• Developer Workstation
• GitHub Repository & Actions (CI/CD)
• Build Tools:
• Ruby + Jekyll + Asciidoctor
• NodeJS + PostCSS + Tailwind + Sass
• Style Library Service (stylesheet-factory)
• Static Assets (images, PPTX, meta-models)
• AWS S3 Bucket (static hosting) + optional CDN (CloudFront)
• End-User Browser
b. Relationships & Interactions
1. Developer edits content in landing/ or stylesheet-factory/.
2. Local build: Asciidoctor processes .adoc → HTML fragments; Sass compiles SCSS → CSS; Jekyll stitches Markdown + HTML + CSS → static site.
3. Push to GitHub → triggers CI workflows:
• Workflow “adoc-build-push_s3” (builds Asciidoc site → S3)
• Workflow “jekyll-build-push-S3-v2” (builds Jekyll site → S3)
4. S3 serves static files (optionally fronted by CloudFront).
5. End user requests site → Browser downloads HTML/CSS/JS/assets.
c. Architectural Patterns & Principles
• Static Site Generation (SSG)
• CI/CD via GitOps (GitHub Actions → S3)
• Modular styling: central Sass library reused across docs
• Content-driven: separation of content (Asciidoc/Markdown) and presentation (Jekyll layouts + Tailwind)
d. Key Technologies/Frameworks
• Jekyll, Asciidoctor, Ruby/Bundler
• NodeJS, PostCSS, Tailwind CSS, Yarn
• Sass/SCSS compiler in stylesheet-factory
• GitHub Actions (YAML workflows)
• AWS S3 (static hosting), CloudFront (optional CDN)