Skip to content

docs(site): add the Diátaxis documentation site - #147

Merged
AojdevStudio merged 1 commit into
mainfrom
docs/diataxis-site
Sep 2, 2026
Merged

AojdevStudio merged 1 commit into
mainfrom
docs/diataxis-site

Conversation

@AojdevStudio

Copy link
Copy Markdown
Owner

Why

Wayfinder #131, phase P4. The repository's docs/ and the Wiki were reorganised into a Diátaxis site on the fixed AOJ Astro Starlight starter, so installers get tutorials, how-to guides, reference, and explanation from one place.

Scope

  • docs-site/: generated once with the starter's create_site.py, then twenty authored pages: two tutorials, five how-to guides, five reference pages, three explanation pages, plus section indexes. Every authored page ends with its source line. Plugin install is labelled planned.
  • .github/workflows/docs.yml: the bundled Pages workflow with the site path set. Pages is not enabled; that is the owner's gate.
  • No tracked file outside those paths changed.

Verification

  • No template tokens remain. bun install, bun run check (0 errors), and bun run build (21 pages, search index, sitemap) succeed.
  • A resolver over every href in the built HTML found zero broken internal links.

Refs #131.

Written by a Claude Fable 5 lane on dev-substrate from a written brief; reviewed and committed by Claude Fable 5.1 running in Claude Code as the program coordinator.

…starter

Twenty pages across tutorials, how-to guides, reference, and explanation,
generated from docs/, the Wiki pages, and the engine source, each ending
with its source line. Builds green with search and sitemap; a resolver
over the built HTML found zero broken internal links. The Pages workflow
is added but Pages is not enabled here.

Refs #131
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Sep 2, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-09-02T02:23:15.897463Z b730de6 PR opened
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@coderabbitai

coderabbitai Bot commented Sep 2, 2026

Copy link
Copy Markdown
Contributor

Warning

Review limit reached

Next included review available in 20 minutes.

Check out review usage here.

View limit details

Limit details: You’ve used all 2 included reviews currently available.

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

Learn how review limits work.

Review configuration:

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Team

Run ID: 3b8f3eb8-7704-4a5c-baff-4128a9a42072

📥 Commits

Reviewing files that changed from the base of the PR and between c1e77fb and b730de6.

⛔ Files ignored due to path filters (3)
  • docs-site/bun.lock is excluded by !**/*.lock
  • docs-site/package-lock.json is excluded by !**/package-lock.json
  • docs-site/public/favicon.svg is excluded by !**/*.svg
📒 Files selected for processing (27)
  • .github/workflows/docs.yml
  • docs-site/.gitignore
  • docs-site/astro.config.mjs
  • docs-site/package.json
  • docs-site/src/content.config.ts
  • docs-site/src/content/docs/explanation/architecture-and-data-flow.md
  • docs-site/src/content/docs/explanation/index.md
  • docs-site/src/content/docs/explanation/open-core.md
  • docs-site/src/content/docs/explanation/privacy-model.md
  • docs-site/src/content/docs/how-to/configure-live-sync-credentials.md
  • docs-site/src/content/docs/how-to/generate-a-report.md
  • docs-site/src/content/docs/how-to/index.md
  • docs-site/src/content/docs/how-to/migrate-an-instance.md
  • docs-site/src/content/docs/how-to/run-the-syncs.md
  • docs-site/src/content/docs/how-to/troubleshoot.md
  • docs-site/src/content/docs/index.md
  • docs-site/src/content/docs/reference/cli.md
  • docs-site/src/content/docs/reference/data-classification.md
  • docs-site/src/content/docs/reference/environment-variables.md
  • docs-site/src/content/docs/reference/hooks-and-skills.md
  • docs-site/src/content/docs/reference/index.md
  • docs-site/src/content/docs/reference/instance-layout.md
  • docs-site/src/content/docs/tutorials/index.md
  • docs-site/src/content/docs/tutorials/your-first-analysis.md
  • docs-site/src/content/docs/tutorials/your-first-instance.md
  • docs-site/src/styles/aoj-docs.css
  • docs-site/tsconfig.json

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@AojdevStudio
AojdevStudio merged commit 83077d6 into main Sep 2, 2026
18 checks passed
@AojdevStudio
AojdevStudio deleted the docs/diataxis-site branch September 2, 2026 02:30
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