-
Notifications
You must be signed in to change notification settings - Fork 144
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[feat] Linter documentation in GitHub Pages. #263
Conversation
This (incredibly large) PR adds a `docs/` directory that we can serve with GitHub Pages. It provides documentation for three linter rules; the remainder will come in follow-up PRs. Note that as part of this, I intend to enforce (and soon lint for) some consistency on linter rules, including: - One rule per file. - The rule's filename must be derived from the rule name (converting `-` to `_` but no other changes). This is to make things like "View Implmenetation" easy.
Print mode looks good too, although I need to figure out what is up with the big blank space on the top. I bet that is broken on the AIP site also. Note that the incorrect and correct protos now start with |
This is not perfect, but it is definitely good enough. I want to merge it and then make incremental improvements. This will also unblock getting documentation written for other rules. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The pages look wonderful!!! And thank you so much for walkthrough on different pages! I quickly approved this PR without deep review. And as you said, we can make more incremental changes after this PR.
This (incredibly large) PR adds a
docs/
directory that we can serve with GitHub Pages.It provides documentation for three linter rules; the remainder will come in follow-up PRs.
Note that as part of this, I intend to enforce (and soon lint for) some consistency on linter rules, including:
(converting
-
to_
but no other changes).This is to make things like "View Implmenetation" easy.