Skip to content

docs: publish Zensical documentation site - #14

Open
lan496 wants to merge 19 commits into
mainfrom
codex/eager-shrike
Open

docs: publish Zensical documentation site#14
lan496 wants to merge 19 commits into
mainfrom
codex/eager-shrike

Conversation

@lan496

@lan496 lan496 commented Sep 6, 2026

Copy link
Copy Markdown
Member

Summary

  • add a Zensical documentation site branded with a symbol-only SpinForge logo, with generated API reference, local preview/build commands, and a least-privilege GitHub Pages workflow using dorny/paths-filter
  • organize authored documentation around reader prerequisites and intent, put the first-read learning section first in the sidebar, separate authored technical references from the generated API reference, and keep duplicated guidance out of the README
  • show the permitted paper schematics as direct PNG previews, retain the notebooks under docs/paper/, link to rendered notebook views, and configure MathJax for equations

Test plan

  • uv lock --check
  • just docs-build (strict Zensical build)
  • crawl generated documentation and verify internal links and assets return successfully
  • uv run prek run --all-files
  • just test (174 passed)

Implements the locally verifiable work in #13. The issue remains open to confirm the live GitHub Pages deployment after merge.

lan496 and others added 5 commits September 6, 2026 11:33
Co-Authored-By: Codex <noreply@openai.com>
Co-Authored-By: Codex <noreply@openai.com>
Co-Authored-By: Codex <noreply@openai.com>
Co-Authored-By: Codex <noreply@openai.com>
Co-Authored-By: Codex <noreply@openai.com>
@lan496
lan496 marked this pull request as ready for review September 6, 2026 03:11
lan496 and others added 14 commits September 6, 2026 12:13
Co-Authored-By: Codex <noreply@openai.com>
Co-Authored-By: Codex <noreply@openai.com>
Co-Authored-By: Codex <noreply@openai.com>
Co-Authored-By: Codex <noreply@openai.com>
Co-Authored-By: Codex <noreply@openai.com>
Co-Authored-By: Codex <noreply@openai.com>
Co-Authored-By: Codex <noreply@openai.com>
Co-Authored-By: Codex <noreply@openai.com>
Co-Authored-By: Codex <noreply@openai.com>
Co-Authored-By: Codex <noreply@openai.com>
Co-Authored-By: Codex <noreply@openai.com>
Co-Authored-By: Codex <noreply@openai.com>
Co-Authored-By: Codex <noreply@openai.com>
Co-Authored-By: Codex <noreply@openai.com>
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