Skip to content

docs: convert manual chapters to .autodoc#314

Merged
fingolfin merged 1 commit intomasterfrom
codex/autodoc-dogfood-manual-176
Mar 6, 2026
Merged

docs: convert manual chapters to .autodoc#314
fingolfin merged 1 commit intomasterfrom
codex/autodoc-dogfood-manual-176

Conversation

@fingolfin
Copy link
Copy Markdown
Member

Rewrite the hand-written manual chapters in .autodoc and update
the dogfood fixtures to validate the generated manual output.

Refresh manual cross-references and clean stale generated chapter
XML files before regenerating expected output.

Resolves #176

Co-authored-by: Codex codex@openai.com

@codecov
Copy link
Copy Markdown

codecov bot commented Mar 5, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 85.85%. Comparing base (94ab263) to head (cebb898).
⚠️ Report is 2 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master     #314      +/-   ##
==========================================
+ Coverage   85.72%   85.85%   +0.12%     
==========================================
  Files          13       13              
  Lines        2438     2439       +1     
==========================================
+ Hits         2090     2094       +4     
+ Misses        348      345       -3     
Files with missing lines Coverage Δ
gap/AutoDocMainFunction.gi 80.76% <100.00%> (ø)
gap/Magic.gd 100.00% <ø> (ø)
makedoc.g 100.00% <100.00%> (ø)

... and 3 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@fingolfin fingolfin force-pushed the codex/autodoc-dogfood-manual-176 branch 3 times, most recently from 7548483 to 42f207d Compare March 6, 2026 01:44
Rewrite the hand-written manual chapters in .autodoc and update
the dogfood fixtures to validate the generated manual output.

Refresh manual cross-references and clean stale generated chapter
XML files before regenerating expected output.

Resolves #176

Co-authored-by: Codex <codex@openai.com>
@fingolfin fingolfin force-pushed the codex/autodoc-dogfood-manual-176 branch from 42f207d to cebb898 Compare March 6, 2026 09:22
@fingolfin fingolfin merged commit 67440a3 into master Mar 6, 2026
8 checks passed
@fingolfin fingolfin deleted the codex/autodoc-dogfood-manual-176 branch March 6, 2026 09: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.

Document AutoDoc with AutoDoc and use the AutoDoc manual as a test

1 participant