Skip to content

Split the grimoire docs into multiple files#788

Merged
jackfirth merged 1 commit into
masterfrom
split-grimoire
Jul 3, 2026
Merged

Split the grimoire docs into multiple files#788
jackfirth merged 1 commit into
masterfrom
split-grimoire

Conversation

@jackfirth

@jackfirth jackfirth commented Jul 3, 2026

Copy link
Copy Markdown
Owner

The grimoire's gonna get big, in theory. This PR splits it up into per-module files plus a table-of-contents file.

Each documented module now has a matching .scrbl file next to it in
the grimoire/ collection, pulled into grimoire.scrbl via
include-section. The grimoire itself is now a 'toc-style part with a
local table of contents, so each API section renders as its own page.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@jackfirth jackfirth added the documentation Improvements or additions to documentation label Jul 3, 2026
@jackfirth jackfirth changed the title Split the grimoire into per-module section files Split the grimoire docs into multiple files Jul 3, 2026
@jackfirth jackfirth enabled auto-merge (squash) July 3, 2026 05:01
@coveralls

Copy link
Copy Markdown

Coverage Status

coverage: 93.813% (-0.02%) from 93.834% — split-grimoire into master

@github-actions github-actions Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Resyntax analyzed 0 files in this pull request and found no issues.

@jackfirth jackfirth merged commit a3a844a into master Jul 3, 2026
7 checks passed
@jackfirth jackfirth deleted the split-grimoire branch July 3, 2026 05:06
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