Add GitHub Pages site under docs/ with Jekyll + Actions deploy#26
Merged
Conversation
- Jekyll 4.x project under docs/ (Gemfile, _config.yml, .ruby-version 3.3.6) - Layouts: default (skip-link, landmarks, SEO, OG fallback) + page (h1) - Includes: header/footer/nav, mermaid_block, minimal_module.py - Theming: tokens.css (light/dark, AA contrast) + main.css (mobile-first) - JS: nav (mobile menu), lightbox (dialog + polyfill), demo (fetch+render), mermaid-loader (lazy CDN load) - Data: navigation, modules (14), screenshots, core_services, demo_schema - Pages: index, architecture, features, screenshots, demo - Validators: check_frontmatter, check_screenshots, validate_demo_schema + 11 unit tests - CI: .github/workflows/pages.yml (build + deploy via actions/deploy-pages) Spec: .kiro/specs/github-pages-site
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds a static documentation/marketing site for ContaAutónomo under
docs/, plus a GitHub Actions workflow that builds and deploys it to GitHub Pages.Implements spec
/.kiro/specs/github-pages-site(requirements, design, tasks).What's included
Jekyll project (
docs/)Gemfile,_config.yml,.ruby-version(3.3.6),404.htmldefault.html(skip-link, landmarks, SEO, OG image fallback),page.html(single<h1>+ optional breadcrumbs)header,footer,nav,mermaid_block,code/minimal_module.pyTheming
tokens.css— light/dark viaprefers-color-scheme, AA contrast, breakpoint tokensmain.css— mobile-first,:focus-visible, screenshot grid, table/code styles, lightbox dialogJavaScript (vanilla, no deps)
nav.js— mobile menu toggle, Escape closes, focus returnlightbox.js—<dialog>with manual polyfill, focus trap, image-error placeholderdemo.js— fetchesdemo_data.json, renders invoices/customers/expenses + IVA/IRPF/SS breakdownmermaid-loader.js— lazy CDN load only when.mermaidelements existData files
navigation.yml,modules.yml(14 modules, sourced from realmodules/<id>/index.py),screenshots.yml,core_services.yml,demo_schema.jsonPages
index.md(landing),architecture.md,features.md,screenshots.md,demo.mdValidators + tests (
docs/tools/)check_frontmatter.py— title (30–60), description (50–160), permalink, uniquenesscheck_screenshots.py— file existence + alt/caption lengthvalidate_demo_schema.py— JSON Schema (draft 2020-12)tests/— 11 pytest cases, all passingCI (
.github/workflows/pages.yml)mainfiltered ondocs/**,demo_data.json,.github/workflows/pages.yml+workflow_dispatchpages: write,id-token: write)actions/upload-pages-artifact@v3actions/deploy-pages@v4.github/workflows/security.ymlis not modifiedVerifications run locally
python3 docs/tools/check_frontmatter.py docs→OK: validated 5 filespython3 docs/tools/validate_demo_schema.py demo_data.json docs/_data/demo_schema.json→ schema OKpython3 -m pytest docs/tools/tests/ -v→ 11 passednode --checkclean.github/workflows/pages.ymlanddocs/are added;security.ymlis byte-identicalKnown follow-ups (not blocking merge)
docs/assets/img/screenshots/. Thecheck_screenshotsandhtmlprooferworkflow steps are wrapped incontinue-on-error: trueuntil they're added; flip back to strict once the images land.ruby/setup-ruby.One-time maintainer setup (after merge)
main(require PR + approvals +Deploy GitHub Pages / buildstatus check)After merge, the site auto-deploys to
https://mborchuk.github.io/ContaAutonomo/.