Repository navigation
Groups hexdocs pages by kind; adds docs manifest - #43
Merged
Merged
Conversation
The decision records under docs/adr leave the published extras and their group: they are a record for contributors, and the README already links them on GitHub by absolute URL. The extras are the README (the front page) and the CHANGELOG, ungrouped at the top. groups_for_extras is empty until the first page arrives; its groups will be Tutorials, How-to guides, Reference, Explanation and Upgrading, in that order. The module groups are unchanged. .claude/diataxis.md is the docs manifest the documentation tools read: the audience, the example world (the library loan), where each kind of page lives, and which paths are for contributors only. Refs: sd-gzj
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What changes
docs/adrleave the published extras and the "Architecture decisions" group. The extras are the README (stillmain) and the CHANGELOG, ungrouped at the top of the sidebar.groups_for_extrasis empty: a group is added with its first page, and the groups, in order, are Tutorials, How-to guides, Reference, Explanation and Upgrading. The comment aboveextrasinmix.exssays so.groups_for_modulesand the module pages (the API reference);package.files, which has never carrieddocs/adrordocs/spikes; the README, which already links the decision records on GitHub by absolute URL; no file underlib/..claude/diataxis.mdis new: the manifest the documentation tools read (audience, terminology, the example world, where each kind of page lives, the contributor-only paths). It is the generated file, byte for byte; neither prose line was changed.No changelog fragment: the repo's
changelog.d/README.mdexcludes documentation changes.Provenance
The package-files rule (decision records are never added to the package files; the README links them by absolute URL) was ruled by the operator, 2026-10-05.
Checks
mix qualitygreen on this commit, including the Docs stage (ExDoc warnings as errors) and the doc_links stage.mix docsbuilds no page for any decision record; the README and CHANGELOG pages and every module page are built.