Skip to content

docs: reorganize the navigation - #230

Open
jmineau wants to merge 2 commits into
mainfrom
docs/reorganize-nav
Open

jmineau wants to merge 2 commits into
mainfrom
docs/reorganize-nav

Conversation

@jmineau

@jmineau jmineau commented Oct 15, 2026

Copy link
Copy Markdown
Owner

The top bar becomes Getting Started, Tutorials, User Guide, API Reference, and Development. It was eight entries, two of them under a "More" menu.

  • Coming From Another STILT moves under the User Guide (guides/migration/). The landing page tile now says "Coming from another STILT?" and links to that index.
  • Development holds three pages: Architecture, STILT-R Parity (split out of the old Development page), and Roadmap.
  • How PYSTILT tracks finished work is merged into Architecture. The two pages said much of the same thing, so the repeated paragraphs are gone and the facts only the old page had (workdir names, killed runs, atomic writes, config-order variants) are in Architecture. The Internals section is removed. The finished-work label keeps the cross references from the stiltctl page and the project reference.
  • The guide to writing docs (voice, API pages, how examples run) moves from the Development page to CONTRIBUTING.md, in its own commit. It tells contributors how to write text for the repository, so it does not need to be on the site. Drop that commit to keep it on the site.

Old addresses change (roadmap.html, development.html#stilt-r-parity, migration/*, advanced/*). README, AGENTS.md, CONTRIBUTING.md, and the Unreleased changelog entry now name the new ones. Nothing else in the other packages links to them.

sphinx-build -W passes on both commits.

Open in this package: #229 edits docs/migration/stilt_r.rst, docs/migration/x_stilt.rst, docs/advanced/architecture.rst, and docs/roadmap.rst. Git follows the renames, so whichever merges second rebases onto the first.

The top bar is Getting Started, Tutorials, User Guide, API Reference, and
Development.

- Coming From Another STILT moves under the User Guide
  (guides/migration/), and the landing page tile names it, not STILT-R.
- Development holds Architecture, STILT-R Parity (split out of the
  Development page), and Roadmap.
- "How PYSTILT tracks finished work" is merged into Architecture, which
  already said much of it. The Internals section is gone.
The voice, API page, and example rules are for people who write text for
the repository, so they sit with the other contributor instructions. The
Development section of the site keeps the pages about how PYSTILT is built
and checked.
@codecov

codecov Bot commented Oct 15, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ All tests successful. No failed tests found.

This branch has not been deployed

No deployments
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