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: AutoCon1 Documentation Updates #616

Merged
merged 54 commits into from
May 1, 2024

Conversation

crankynetman
Copy link
Contributor

@crankynetman crankynetman commented Apr 15, 2024

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.
  • I also went ahead and added all of the skeleton files for all of the medium and low priority documentation that we want to add in the future.
    • Reminder: the full list of things we wanted docuemented is here.
  • I guess I added a bunch of docs or something too.
    • Domain Models
    • Forms
    • Subscriptions (Lives on the domain model docs)
    • App.py
    • Workflow Steps
    • I cleaned up and refactored a bunch of docs along the way.

@crankynetman crankynetman marked this pull request as ready for review April 15, 2024 21:55
Copy link

codecov bot commented Apr 15, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 84.48%. Comparing base (3fce536) to head (aee537f).

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.
📢 Have feedback on the report? Share it here.

@crankynetman crankynetman self-assigned this Apr 16, 2024
@crankynetman
Copy link
Contributor Author

Closes #529, #532, #539, #540, #543, and #545.

mkdocs.yml Show resolved Hide resolved
Copy link
Contributor

@tjeerddie tjeerddie left a 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?

crankynetman and others added 4 commits April 30, 2024 09:55
Co-authored-by: tjeerddie <tjeerdverschragen@hotmail.com>
Co-authored-by: tjeerddie <tjeerdverschragen@hotmail.com>
@crankynetman
Copy link
Contributor Author

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.

#616 (comment)

@anieuwland anieuwland force-pushed the feat/partner-meeting-doc-updates branch from 5cef979 to aee537f Compare May 1, 2024 11:24
@anieuwland
Copy link

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.

@anieuwland anieuwland merged commit 2ae459c into main May 1, 2024
16 checks passed
@anieuwland anieuwland deleted the feat/partner-meeting-doc-updates branch May 1, 2024 11:39
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.

5 participants