docs(output): Document semantic output and navigation contracts - #37
Merged
Merged
Conversation
philprime
marked this pull request as ready for review
September 25, 2026 12:09
philprime
added this pull request to stack #38
September 25, 2026 12:09
Base automatically changed from
philprime/fix/consolidate-human-rendering
to
main
September 25, 2026 12:09
philprime
force-pushed
the
philprime/docs/document-output-contracts
branch
from
September 25, 2026 12:09
db3cdfb to
4022e4b
Compare
philprime
removed this pull request from stack #38
September 25, 2026 12:14
philprime
enabled auto-merge (squash)
September 25, 2026 12:14
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.
Extract the standalone output-contract documentation from
feature/tuiand link it from the README. Describe audience/format selection, semantic JSON fields, nested content, link targets, navigation limitations, and migration from raw DocC output without introducing browser behavior.Stack
Based on #36. This PR contains documentation only and should merge after it.
Verification
Cross-checked contracts against the serializers and release agent JSON. Passed Markdown formatting,
make test(one expected known issue), andmake analyze.make buildconfirmed the existing release binary is current.