Skip to content
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

Add glossary infrastructure and hover/click definitions. #33118

Closed
wants to merge 6 commits into from

Conversation

Ayushmaan06
Copy link

@Ayushmaan06 Ayushmaan06 commented Jul 29, 2024

Description
Fixes #33117
This pull request introduces a new glossary infrastructure to the OpenPilot documentation. The changes include:

  • Glossary Terms: Added terms to docs/glossary.json .
  • Glossary Page: Created a glossary page under docs/concepts/glossary.md.
  • Hover/Click Definitions: Implemented functionality to show definitions of glossary terms when hovered over or clicked using /static/js/glossary.js and static/main.css.

These updates enhance the documentation by providing easy access to definitions directly within the documentation pages, improving user understanding of OpenPilot concepts.

Verification

  • Confirmed that the new glossary terms are correctly linked and accessible from documentation pages.

Copy link
Contributor

github-actions bot commented Jul 29, 2024

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

@Ayushmaan06 Ayushmaan06 closed this by deleting the head repository Jul 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

docs: setup glossary
1 participant