Skip to content

Add interactive product manual and GitHub Pages deployment - #3

Merged
michaelkage merged 12 commits into
mainfrom
feat/interactive-product-manual
Nov 11, 2026
Merged

michaelkage merged 12 commits into
mainfrom
feat/interactive-product-manual

Conversation

@michaelkage

Copy link
Copy Markdown
Owner

Summary

  • Add docs/index.html, a single-file, zero-JavaScript-dependency manual with the requested warm-paper/ink/vermilion design and dense source-aligned documentation.
  • Add a playable client-side pipeline simulation for daily entry creation, GitHub issue capture, activity collection failure handling, and latest.json generation. The simulation makes no GitHub writes.
  • Document the actual source tree, four workflows, runtime, configuration, data flow, test scope and known constraints.
  • Detect the repository from GitHub Pages / GitHub URL and fetch repository metadata, latest release/assets and latest commit date from the public GitHub API.
  • Detect iframe embedding and suppress outer navigation/chrome.
  • Add .github/workflows/pages.yml using configure-pages, upload-pages-artifact (docs) and deploy-pages.
  • Extend Node built-in tests to parse the inline manual script and check the source-aligned demo; include docs in validation path filters.

Verification

  • Existing Node test suite plus the new manual tests run in CI on this PR.
  • No release is currently published; the manual handles the GitHub API 404 state explicitly.
  • GitHub Pages deployment itself requires Pages to be enabled for the repository and the Actions deployment workflow to complete after merge.

@michaelkage
michaelkage merged commit 0560043 into main Nov 11, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant