-
Notifications
You must be signed in to change notification settings - Fork 15
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: AutoCon1 Documentation Updates #616
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #616 +/- ##
=======================================
Coverage 84.48% 84.48%
=======================================
Files 186 186
Lines 9205 9206 +1
Branches 1539 1539
=======================================
+ Hits 7777 7778 +1
Misses 1153 1153
Partials 275 275 ☔ View full report in Codecov by Sentry. |
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.
can this be linked to issues and already close some?
Co-authored-by: tjeerddie <tjeerdverschragen@hotmail.com>
Co-authored-by: tjeerddie <tjeerdverschragen@hotmail.com>
Thanks for the review @tjeerddie ! I think I addressed all of your comments, which are all great feedback. I think I linked the issues appropriately via this comment, but I'm not 100% sure on that. |
5cef979
to
aee537f
Compare
Awesome docs, Chris, thanks! I updated the branch with a couple of small typo fixes, hope you don't mind. I thought it'd be more efficient than going back and forth between the two of us. |
This implements all of the high priority documentation that we wanted to get done in advance of AutoCon1.
This re-uses a lot of existing docs but also adds in the following new things:
mkdocstrings
which allows us to pull in documentation from our actual code and use our docstrings and code examples instead of re-writing or copy/pasting them in our documentation.mkdocs-macros-plugin
Allows us to add jinja (lol) templates into our docs. We can then use this to pull in examples of implementations from the example orchestrator's main branch. With this, we can show real running examples of code but not have to maintain it in two places.abbr
Allows us to add abbreviations to mkdocs that show up anywhere that abbreviation is used as a tooltip.