docs: user guide for publishing via Modal #551
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #551 +/- ##
=======================================
Coverage 74.94% 74.94%
=======================================
Files 38 38
Lines 2407 2407
=======================================
Hits 1804 1804
Misses 603 603 ☔ View full report in Codecov by Sentry. |
OwenPriceSkelly
requested changes
Oct 31, 2024
There was a problem hiding this comment.
This is a great first pass, thanks for jumping on it!
couple of things I didn't mention in other comments: I think we should add the new docs to the nav bar so it shows up when I click User Guide (see mkdocs.yml) and I think we should disclaim at the beginning that this is an experimental / limited beta feature and users should reach out if they're interested in trying it
Co-authored-by: Owen Price Skelly <21372141+OwenPriceSkelly@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Resolves: #547
Overview
This PR adds a page to the user guide detailing the process of publishing a Garden using Modal. The new page details the flow @shane-jung added in #215.
Testing
Check out the new page locally with
mkdocs serveDocumentation
It's all docs!
📚 Documentation preview 📚: https://garden-ai--551.org.readthedocs.build/en/551/