Repository navigation
Groups the hexdocs pages by kind of page - #240
Merged
Merged
Conversation
The sidebar groups its extras as How-to guides, Reference and Explanation, in the family order, with the README and the CHANGELOG ungrouped at the top. Custom functions, embedding and porting are the how-to guides, and each H1 now starts "How to"; the nested data access, location expressions and simple subset pages describe a surface, so they join the reference pages; the architecture page is the explanation. No file is renamed. docs/contributing.md and LICENSE leave the extras and still ship in the package; the README links both by absolute GitHub URL. Adds .claude/diataxis.md, the docs manifest the documentation tools read. Refs: px-dl23
Codecov Report✅ All modified and coverable lines are covered by tests. 🚀 New features to boost your workflow:
|
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
The hexdocs sidebar groups its extra pages by the kind of page a reader needs, in the family order, using the groups this package has pages for: How-to guides, Reference, Explanation. The README stays the main page; the README and the CHANGELOG stay ungrouped at the top. The API reference (the module pages) is unchanged.
docs/guides/keeps its name.docs/guides/that describe a surface rather than a task: nested data access, location expressions, the simple subset.docs/contributing.mdandLICENSEleave the extras (neither has a group in the family order) and still ship in the package files. The README's links to both become absolute GitHub URLs, because the doc links stage fails a relative link from an extra to a page that is not an extra. Decision records and planning notes were already outside the extras and the package files; that does not change.Adds
.claude/diataxis.md, the docs manifest the documentation tools read, generated for this repository and unedited. Its example world is the library loan.No file under
lib/changes. No changelog fragment:changelog.d/README.mdexcludes documentation changes.Provenance
docs/contributing.mdandLICENSEleaving the extras, with the README linking them absolutely: decided by the conductor under a standing consent, 2026-10-05.Checks
mix qualitygreen on this head, including the Docs stage (warnings as errors) and the Doc links stage.test/docs_adr_links_test.exsreads the extras frommix.exs; its floors still hold, because the two pages that left carry no ADR link and no baredocs/citation.mix docs --warnings-as-errorsbuild shows the README, the CHANGELOG and the API reference ungrouped, and every other extra in exactly one of the three groups.