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

docs: Improve demo and troubleshooting sections #127

Merged
merged 2 commits into from
Oct 15, 2024

Conversation

KonradBkd
Copy link
Contributor

@KonradBkd KonradBkd commented Sep 27, 2024

Changes

  • Extended build instructions for demo, troubleshooting section
  • Changed demo and utilitiy docs to rst description lists (instead of rst tables)
  • Fixed various paragraphs and typos
  • Centralized substitutions
  • Restructured file structure to represent doc structure
  • css for doxygenfunction

Review Instructions

  • Build the Docs
  • Carefully read the sections with major changes:
    • Demos
    • Troubleshooting
    • API (just the overview page)
  • Review the root structure. Changed chapter titles:
    • 'Simulation' -> 'Simulation Concetps'
    • 'API' -> 'C/C++ API'
  • Condensed 'SIL Kit License' AND 'Third Party Licenses' on the root structure to just 'Licenses'
  • Check the API sections that use breathe directives (doxygenfunction, doxygenclass, ...).
    The custom.css has selectors that effect all of them.

@KonradBkd KonradBkd force-pushed the silkit-1598_improve_docs branch from 37a1a2b to 0d6daa1 Compare September 30, 2024 08:51
@VLukasBecker
Copy link
Contributor

I would suggest to increase the nesting level of the content list of the docu, inorder to make the Vehicle Network Services selectable from the list, as it was possible before.

@VLukasBecker
Copy link
Contributor

The rest lgtm!

docs: restructuring, doxygen style

docs: doxygen font

docs: fixed typos

docs: Add C++ section to structure API overview

docs: Changelog

docs: Improved docs on LinUnknownDatalength and Connection guides

docs: Set sidebar navigation depth to 5

docs: Update changelog

docs: Update changelog
@KonradBkd KonradBkd force-pushed the silkit-1598_improve_docs branch from bcfb345 to 2a4cee3 Compare October 15, 2024 09:52
@KonradBkd
Copy link
Contributor Author

I would suggest to increase the nesting level of the content list of the docu, inorder to make the Vehicle Network Services selectable from the list, as it was possible before.

I increased the global navigation_depth from 4 to 5, no it reaches the Vehicle Network Services again

Copy link
Contributor

@VLukasBecker VLukasBecker left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@KonradBkd KonradBkd merged commit fd531e4 into main Oct 15, 2024
21 checks passed
@KonradBkd KonradBkd deleted the silkit-1598_improve_docs branch October 15, 2024 11:46
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.

2 participants