Remove 'title' frontmatter and improve title handling logic #196
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
Replaced the 'title' frontmatter across documentation with level 1 headings, ensuring compliance with new markdown conventions. Updated the rendering logic in the codebase to emit warnings for deprecated titles and fallback to file names if no headings are found. These changes simplify title management and enhance markdown compatibility.
Added the `--strict` flag to the docs builder for stricter validation. Refactored title handling logic to delay fallback to filename when no title is found. Minor fixes in generated link text in docs for better clarity.
|
Updated this to ensure:
|
reakaleek
approved these changes
Jan 15, 2025
|
#193 has been fixed. This PR can now be merged! |
|
Tested this branch with the integration-docs.md docset and I'm seeing two titles on every page: 
|
…g, we render it through Model.Title explicitly
|
Thanks @bmorelli25 this regression is now fixed again! 
|
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.
Replaced the 'title' frontmatter across documentation with level 1 headings, ensuring compliance with new markdown conventions. Updated the rendering logic in the codebase to emit warnings for deprecated titles and fallback to file names if no headings are found. These changes simplify title management and enhance markdown compatibility.
Requires #193 to be implemented before we can merge and release this otherwise we create to much noise for the bug bash tomorrow.