docs: generate the options reference on demand#237
Merged
Conversation
### Summary Make Flakebox-created development shells and enhanced Crane nextest derivations suppress progress and successful test statuses by default while retaining failure output and final failure statuses. This brings reusable Flakebox defaults in line with tau-agent change qotqkzlqtyqk instead of requiring each consumer to repeat the settings. ### Details Set `NEXTEST_SHOW_PROGRESS=none` and `NEXTEST_STATUS_LEVEL=none` in `mkDevShell` with caller override support, while the enhanced `craneLib.cargoNextest` applies the same defaults to Nix builds. Intentionally leave nextest's final-status setting untouched so its failure-reporting default remains active. Extend nextest checks to assert both defaults, shell overrides, and the absence of a final-status override; document the behavior and regenerate checked-in documentation. Focused builds, formatting, regeneration, direct shell evaluation, `nix develop -c selfci check`, and independent review all passed.
### Summary Stop tracking the generated Nix options reference so routine option changes no longer create large documentation diffs. Keep the options page in the built mdBook and direct repository readers to commands that generate and open the complete documentation locally. ### Details Remove the generated Markdown copy and the update script step that rebuilt and copied it into the repository. The docs derivation now installs only the rendered book and is included in regular flake checks, while AGENTS.md documents both the build-only options reference and README regeneration. README generation replaces the source-only mdBook link with platform-neutral local viewing instructions and asserts the expected SUMMARY entry before applying an exact-match projection; the tutorial provides the same on-demand workflow. ### Reviews A general review covered architecture, maintainability, style, and reliability. Initial review identified cross-platform opener wording, missing README regeneration guidance, an unchecked SUMMARY projection, and missing regular docs build coverage; all were corrected. Re-review caught a mismatch between validation and transformation selectors; both now use the same exact canonical entry. Final re-review passed with no remaining issues.
### Summary Advance the fenix flake input to the current upstream revision so stable and nightly Rust toolchains remain current. The update moves stable Rust from 1.96 to 1.97 and the latest nightly from 1.98 to 1.99. ### Details Update fenix from 9bc51687 to 4e49ef62 and its transitive rust-analyzer source from 7bd90313 to 5be5e89c. The refreshed nightly successfully builds the wild-unwrapped package that consumes fenix latest cargo and rustc. Validation passed via nix develop -c selfci check, direct stable and latest toolchain version checks, and a default package build. ### Reviews Independent review passed with no content issues. It confirmed that the lock update is limited to fenix and its expected rust-analyzer-src dependency, the lock graph remains consistent, and validation covers the affected toolchains and wild-unwrapped build.
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.
PR published by Tau
Summary
Generate the options reference on demand instead of keeping a generated copy in the repository, and refresh the pinned Fenix input.
Details
Reviewer instructions
Please verify that the documented options-reference generation command works and that the flake checks accept the updated lock input.