Repository navigation
docs: correct guide examples and enforce documentation checks - #1492
Merged
Merged
Conversation
doublewhy
force-pushed
the
guides-imports-rename
branch
from
October 11, 2026 12:55
a5dc9eb to
e06cb39
Compare
doublewhy
marked this pull request as ready for review
October 11, 2026 13:26
This was referenced Oct 11, 2026
…s in the CLI and Python guides The CLI guide now says that each raes semantic command reads one document as in-memory text, so a scenario with top-level imports is rejected with exit 1 and only the generic sdl.parse diagnostic, and it points to parse_sdl_file. It also names every command group that the CLI API reference documents. The CLI API reference (docs/public/api/cli.rst) gains sections for the libvirt, corpus and runtime groups, so it covers every group that raes_cli.main registers. The Python guide now says that parse_sdl, given only text, raises SDLParseError for top-level imports, and names parse_sdl_file. The rename example runs on a scenario where the rename succeeds, and the text explains why renaming a node that has an infrastructure entry is refused.
3 tasks
doublewhy
force-pushed
the
guides-imports-rename
branch
from
October 12, 2026 07:57
e06cb39 to
f7dfcdd
Compare
… the reference sentence
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.
Summary
Correct the public CLI and Python guides, make the rename and removal examples succeed, and close the documentation-check gaps found during review.
Changes
__all__.rst2html. Correct the exposed reference prose and headings.Requirement UIDs
Related Issues
No issue: correct public guides and repair their verification without changing package behavior.
The documented product limits are tracked in #1548 and #1550. Documentation-example execution and reStructuredText coverage were reported in #1554 and #1562. This PR does not claim delivery of unrelated issue acceptance criteria or close those issues.
ADR Impact
docs/decisions/pr-1492-guide-checks.md.Test Plan
be4466978: all eight test shards, integration, policy, documentation, proof/model checks, coverage, and the required CI gate passed.Ground Control Checks
Traceability
docs/public/guides/cli.md,docs/public/guides/python.md,docs/public/guides/control-plane.md,docs/public/api/,tools/nox_support/config.py,tools/nox_support/test_lanes.py.implementations/python/tests/test_public_guide_examples.py,implementations/python/tests/test_repo_policy_tools.py.Checklist
Documentation
The public guides and API references describe current behavior. The documentation style guide now names both checked extensions and the parser dependency. No runtime implementation, published schema, release version, or changelog changes.