search

hdresearch / nolita

Work with web-enabled agents quickly — whether running a quick task or bootstrapping a full-stack product.
https://nolita.ai
MIT License
87 stars 6 forks source link

docs: generate API reference from docstrings #72

Closed matildepark closed 4 months ago

matildepark commented 4 months ago

Instead of maintaining this manually we fallback to the docstrings to specify our exports.

Adds typedoc and a markdown plugin to export it as markdown files.

The docs build pipeline will install book-summary to generate a navigation snippet; then we do some bash scripting over the output so that you can run the docs build as many times as you want without constantly mutating the SUMMARY.md file that mdBook uses to make the actual documentation.

On Vercel side, when this merges I just need to add pnpm run build:docs to the build command before prompting it to generate the docs.

vercel[bot] commented 4 months ago

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
nolita ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 6, 2024 9:59pm
matildepark commented 4 months ago

@AlephNotation this is basically good to go.