docs: glossary, keyword matching and tool-tips #34155
Conversation
|
Creating a draft since there are a few issues I need to fix. And I want to review the whole doc. |
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
Thanks for contributing to openpilot! In order for us to review your PR as quickly as possible, check the following:
- Convert your PR to a draft unless it's ready to review
- Read the contributing docs
- Before marking as "ready for review", ensure:
- the goal is clearly stated in the description
- all the tests are passing
- the change is something we merge
- include a route or your device' dongle ID if relevant
|
Did a few changes to allow links within the tooltip description to work. Also added a link to go to the glossary from the tooltip. Glossary:
Keyword matching:
Tooltip:
allows highlighting/copy
links in descriptions
Tapping out for the day. |
|
Just noticed the panda link is breaking when the main doc has a markdown link. Will look into it... EDIT |
LouisVelez
changed the title
|
@maxime-desroches is it ok if I add some flags for the linter to ignore the problem code? Or I'm open to other suggestions. See |
|
No we have to fix the code. ruff offers nice descriptions for each errors: |
@maxime-desroches That was very helpful, thank you. Code fixed, latest static analysis run |
| @@ -18,7 +18,7 @@ concurrency: | |||
| jobs: | |||
| docs: | |||
| name: build docs | |||
| runs-on: ubuntu-latest | |||
| runs-on: ubuntu-24.04 | |||
| @@ -14,23 +14,24 @@ Development is coordinated through [Discord](https://discord.comma.ai) and GitHu | |||
| ## What contributions are we looking for? | |||
|
|
|||
| **openpilot's priorities are [safety](SAFETY.md), stability, quality, and features, in that order.** | |||
| openpilot is part of comma's mission to *solve self-driving cars while delivering shippable intermediaries*, and all development is towards that goal. | |||
| openpilot is part of comma's mission to *solve self-driving cars while delivering shippable intermediaries*, and all development is towards that goal. | |||
There was a problem hiding this comment.
this should be its own PR
| @@ -2,4 +2,4 @@ | |||
|
|
|||
| A brand port is a port of openpilot to a substantially new car brand or platform within a brand. | |||
|
|
|||
| Here's an example of one: https://github.com/commaai/openpilot/pull/23331. | |||
| Here's an example of one: [PR-23331](https://github.com/commaai/openpilot/pull/23331). | |||
There was a problem hiding this comment.
same, this PR shouldn't change any content
| import re | ||
| import tomllib | ||
|
|
||
| with open("docs/glossary.toml", "rb") as f: |
There was a problem hiding this comment.
don't do this at import time
| @@ -31,7 +36,7 @@ nav: | |||
| - Contributing: | |||
| - Roadmap: contributing/roadmap.md | |||
| #- Architecture: contributing/architecture.md | |||
| - Contributing Guide →: https://github.com/commaai/openpilot/blob/master/docs/CONTRIBUTING.md | |||
| - Contributing Guide: CONTRIBUTING.md | |||
Just to make sure I understand correctly: 1 PR for infra only 1 PR for the terms additions. 1 PR for the changes in the content files (markdowns). Does this sound correct? |
|
Yeah, and potentially even split out the content changes per-page. |
|
@adeebshihadeh , going to close this PR and submit the individuals just to start clean. |
Closes #33117
Replaced by #34231