issues
search
Garden-AI
/
garden
https://garden-ai.readthedocs.io
MIT License
21
stars
4
forks
source link
give the docs some ✨ polish ✨
#512
Closed
OwenPriceSkelly
closed
3 months ago
OwenPriceSkelly
commented
4 months ago
Some gripes about the docs:
Clean up home page ("Docs are a WIP" get out of here)
1-sentence elevator pitch and TOC is good
what's the motivation to use this/read the rest of the docs?
Explain Entrypoint concept before Garden concept
Should link to the website
should link to real examples on the website
Fix API autodocs for metadata classes
Include usage example for linking Dataset/Paper/Models
see if we can drop the
garden-ai
prefix on the CLI autodocs TOC
the "User guide" > "Introduction" page is almost identical to the home page
Flesh out FAQs page
Some gripes about the docs:
garden-ai
prefix on the CLI autodocs TOC