Skip to content

docs: Zensical docs site deployed to GitHub Pages - #43

Merged
EnriqueCanals merged 1 commit into
boldblackai:mainfrom
BoldBlackBot:docs/zensical-docs
Aug 18, 2026
Merged

docs: Zensical docs site deployed to GitHub Pages#43
EnriqueCanals merged 1 commit into
boldblackai:mainfrom
BoldBlackBot:docs/zensical-docs

Conversation

@BoldBlackBot

Copy link
Copy Markdown
Contributor

Summary

Gives create-dispatch a documentation website — the same infrastructure the harness project uses:

  • docs/ — 8 pages: index, getting-started, architecture, concepts (skills / security model / secrets), CLI reference, upgrading, teardown. Content grounded in the README, template README, and the three shipped skills; present-tense, user-facing.
  • zensical.toml — pinned to zensical 0.0.43 (same as harness). site_url points at https://dispatch.boldblack.ai/docs/ so canonical tags + sitemap carry the brand domain.
  • .github/workflows/docs.yml — same shape as harness's: build-only check on PRs that touch docs; deploy to GitHub Pages on push to main + workflow_dispatch.
  • site/ gitignored; RFC filed (rfcs/2026-08-18_docs-site.md); AGENTS.md documents the docs workflow.

Follow-up (separate PR, dispatch-site repo): the Amplify build mirrors the published Pages tree into static/docs/ so docs are served at https://dispatch.boldblack.ai/docs/.

Test plan

  • zensical build --clean — no issues, canonical at dispatch.boldblack.ai/docs/, all internal links relative
  • pnpm lint:md / pnpm format:check / actionlint — clean
  • Golden test unaffected (no template changes)

One-time console step after merge

Enable GitHub Pages: Settings → Pages → Source: GitHub Actions (repo has no Pages today). CI's docs deploy will then publish on the next docs change (or workflow_dispatch).

Note: merge order matters — the dispatch-site mirror PR must not ship before Pages is live (its mirror step hard-fails on an empty sitemap).

Adds docs/ (8 pages), zensical.toml, and .github/workflows/docs.yml —
the same docs infrastructure the harness project uses:

- Zensical builds docs/ and deploys to GitHub Pages (build-only check
  on PRs; deploy on push to main + workflow_dispatch)
- site_url points at https://dispatch.boldblack.ai/docs/ — the
  dispatch-site Amplify build mirrors the published Pages tree into
  static/docs/ (separate PR in dispatch-site), byte-identical, no
  rebuild drift
- Zensical's relative links make the tree relocatable under /docs/;
  canonical + sitemap carry the brand domain
- site/ build output gitignored; RFC filed; AGENTS.md documents the
  docs workflow

Verified locally: zensical build --clean (0.54s, no issues),
markdownlint, oxfmt, actionlint, golden test.

Co-Authored-By: Julio Capote <6135+capotej@users.noreply.github.com>
@EnriqueCanals
EnriqueCanals merged commit d3c73ac into boldblackai:main Aug 18, 2026
3 checks 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.

2 participants