Improved Documentation UX #6283
Merged
Conversation
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
jutaro
force-pushed
the
jutaro/docu_generation2
branch
from
cf1fd48 to
21a06e0
Compare
jutaro
force-pushed
the
jutaro/docu_generation2
branch
from
4ebda3d to
24938d2
Compare
mgmeier
requested changes
Jul 17, 2025
jutaro
force-pushed
the
jutaro/docu_generation2
branch
2 times, most recently
from
ae16072 to
a21760f
Compare
jutaro
force-pushed
the
jutaro/docu_generation2
branch
from
a21760f to
121826b
Compare
github-merge-queue
bot
removed this pull request from the merge queue due to failed status checks
This was referenced Jul 22, 2025
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.
Improved Documentation UX
This PR improves the structure and metadata of the generated tracer documentation to enhance clarity and maintainability.
Changes
Simplified table of contents
Only top-level tracers are now listed, improving readability and reducing noise in the generated index.
Footer generation localized to
cardano-nodeMoved footer generation logic from
trace-dispatcherintocardano-node, maintaining purity in the library and ensuring accurate, context-specific metadata.Enhanced footer content
The documentation footer now includes:
cardano-nodeversion