Skip to content

feat(docs): add zensical documentation site#3

Merged
eric-tramel merged 13 commits intomainfrom
codex/zensical-docs
May 5, 2026
Merged

feat(docs): add zensical documentation site#3
eric-tramel merged 13 commits intomainfrom
codex/zensical-docs

Conversation

@eric-tramel
Copy link
Copy Markdown
Contributor

Summary

  • Add a Zensical documentation configuration for the repo and replace the old hand-authored docs/adding-a-plugin.md content with focused authoring, workflow, release, and landing pages.
  • Keep the generated plugin catalog as part of the docs site while preserving the existing ddp catalog freshness check.
  • Add a GitHub Pages documentation workflow that builds docs on relevant PRs, uploads a preview artifact, and deploys the built site/ directory from pushes to main.
  • Add make docs, include docs in make all, lock Zensical as a dev dependency, ignore generated site/, and update README/PR checklist links.

Why

The repo currently has Markdown docs but no documentation site or Pages deployment path. Zensical is a small fit here because the repo already uses Python and uv, and its build can validate internal links in strict mode before deployment.

Validation

  • make sync
  • make docs
  • make check
  • make all

@eric-tramel eric-tramel marked this pull request as ready for review May 4, 2026 18:04
@eric-tramel eric-tramel requested a review from a team as a code owner May 4, 2026 18:04
@eric-tramel eric-tramel changed the title [codex] add zensical documentation site feat(docs): add zensical documentation site May 4, 2026
@eric-tramel eric-tramel self-assigned this May 4, 2026
@eric-tramel eric-tramel added the documentation Improvements or additions to documentation label May 5, 2026
@eric-tramel eric-tramel merged commit 114db84 into main May 5, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants