Docs: improve structure for manifest entry fields #13333
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
github-actions
bot
added
docs
Specification
|
@manuzhang @nastra Could you please take a look? |
nastra
reviewed
Jun 23, 2025
|
|
||
| `data_file` is a struct with the following fields: | ||
| #### Manifest Entry Fields |
There was a problem hiding this comment.
can you please add the heading without actually modifying the table since that causes unnecessary diffs during review
There was a problem hiding this comment.
I've reverted the changes to manifest entry table. Please let me know if you want me to reduce the restructing to make the diff even clearer.
nastra
approved these changes
Jun 27, 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.
Introduce explicit Markdown headings for the
manifest_entryanddata_filestructs so other documentation sections (for example, the Entries metadata-table page from #13104) can deep-link to them.These headings automatically generate the anchors #manifest-entry-fields and #data-file-fields.
During review of #13104 it became clear that we cannot currently link to individual struct definitions because the headings (and therefore anchors) are missing. Adding them here resolves the issue in a docs-only change.