Skip to content

Groups the hexdocs pages by kind of page - #240

Merged
johnnyt merged 1 commit into
mainfrom
px-dl23-hexdocs-groups-manifest
Oct 5, 2026
Merged

johnnyt merged 1 commit into
mainfrom
px-dl23-hexdocs-groups-manifest

Conversation

@johnnyt

@johnnyt johnnyt commented Oct 5, 2026

Copy link
Copy Markdown
Member

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.

  • How-to guides: custom functions, embedding compiled programs, porting. Each H1 now starts "How to"; no file is renamed and docs/guides/ keeps its name.
  • Reference: the language reference, the AST reference, the ISA reference, and three pages under docs/guides/ that describe a surface rather than a task: nested data access, location expressions, the simple subset.
  • Explanation: the architecture page.

docs/contributing.md and LICENSE leave 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.md excludes documentation changes.

Provenance

  • docs/contributing.md and LICENSE leaving the extras, with the README linking them absolutely: decided by the conductor under a standing consent, 2026-10-05.
  • Grouping nested data access, location expressions and the simple subset as Reference rather than How-to guides: an engineering choice made in this PR. Each reads as a description of an API surface (notations, valid targets and error types, a value and its laws), not as steps toward a goal, so a "How to" title would not fit them.

Checks

  • Full mix quality green on this head, including the Docs stage (warnings as errors) and the Doc links stage.
  • test/docs_adr_links_test.exs reads the extras from mix.exs; its floors still hold, because the two pages that left carry no ADR link and no bare docs/ citation.
  • A local mix docs --warnings-as-errors build shows the README, the CHANGELOG and the API reference ungrouped, and every other extra in exactly one of the three groups.
  • The two new absolute README links answer 200.

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

codecov Bot commented Oct 5, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

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

@johnnyt
johnnyt merged commit 327b6ee into main Oct 5, 2026
2 checks passed
@johnnyt
johnnyt deleted the px-dl23-hexdocs-groups-manifest branch October 5, 2026 11:18
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.

1 participant