Repository navigation
Groups hexdocs extras by kind of page - #687
Merged
Merged
Conversation
The one guide hexdocs ships, describing-a-document, now sits under How-to guides; the README and the CHANGELOG stay ungrouped at the top, and the module groups are unchanged. Three how-to pages that do not ship (flow patterns, profiles, theming) take H1s that start "How to"; no file is renamed. The repository gains .claude/diataxis.md, the docs manifest the documentation tools read, set in patron registration. No file under lib changes. Refs: sb-agxp
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
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
mix.exsgainsgroups_for_extras. The one guide hexdocs ships,docs/describing-a-document.md, sits under How-to guides. The README (stillmain) and the CHANGELOG stay ungrouped at the top.extrasandgroups_for_modulesare unchanged, so the API reference reads as before.docs/adr,docs/plansordocs/spikesis inextrastoday, and none is added;package.filesis unchanged and names nothing underdocs/. The README links the decision records by absolute GitHub URL.docs/describing-a-document.mdalready did;docs/guides/flow-patterns.md,docs/profiles.mdanddocs/theming.mdchange their H1 line only. No file is renamed anddocs/guides/keeps its name..claude/diataxis.mdis new: the docs manifest the documentation tools read, generated from the family's manifest table and committed byte for byte as generated. Its example world is patron registration (a visitor becomes a library patron through a few screens).No file under
lib/changes. No changelog fragment:changelog.d/README.mdexcludes documentation changes.Provenance
extraswas decided under the night rule by the conductor, 2026-10-05; the rewritten acceptance ondocs/adrwas ruled by the operator, 2026-10-05.Checks
mix quality, full profile, green: the Docs stage (mix docs, warnings as errors) and the Doc links stage included.mix docsbuild's sidebar puts the describing-a-document guide under How-to guides and leaves the README and the CHANGELOG ungrouped; the module groups are as on main.