Various documentation fixes #2699
Merged
Conversation
This file contains 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
Change links to absolute to make them work on https://square.github.io/wire/
Shorten line length to remove the horizontal scrollbar
Fixes mkdocs warning `Doc file 'index.md' contains an unrecognized relative link 'wire_compiler', it was left as is.`
Added md_in_html extension to render markdown links inside raw HTML `<details>` blocks. Changed links to absolute to make them work on https://square.github.io/wire/
Added `not_in_nav` parameter with a list of auto-generated and other docs not explicitly listed in the navigation block to reduce the number of warnings from mkdocs.
oldergod
approved these changes
Nov 3, 2023
There was a problem hiding this comment.
Thank you!
If not done already, could you please sign our CLA so that I can merge it?
Comment on lines
-28
to
-31
| # sed -i 's/docs\/wire_compiler.md/wire_compiler/' README.md | ||
| # sed -i 's/docs\/wire_compiler.md/wire_compiler.md/' README.md | ||
| # OSX | ||
| sed -i "" 's/docs\/wire_compiler.md/wire_compiler/' README.md | ||
| sed -i "" 's/docs\/wire_grpc.md/wire_grpc/' README.md |
There was a problem hiding this comment.
I don't understand why these need a change. What is broken with them?
There was a problem hiding this comment.
It works now, but mkdocs emits a warning:
Doc file 'index.md' contains an unrecognized relative link 'wire_compiler', it was left as is.
Because it expects all internal links to be links to existing files.
This change is only to fix this warning.
Done |
|
Thank you! |
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.
This PR fixes some broken links on https://square.github.io/wire/ and also has a minor formatting improvements.
Some of the visible changes:
SchemaHandler,SchemaHandler.Factoryandrecipeslinks on wire_compiler/#custom-handlers