Skip to content

Adds docs + docs website#219

Merged
leggetter merged 31 commits into
mainfrom
feat/docs
Jan 23, 2025
Merged

Adds docs + docs website#219
leggetter merged 31 commits into
mainfrom
feat/docs

Conversation

@leggetter

Copy link
Copy Markdown
Collaborator

Experimenting with using Zudoku by Zuplo. It's open source and doesn't require a license to build and deploy the docs which feels more in keeping with Outpost.

The idea is that it'll be deployed to Vercel, and we'll have a proxy to serve the contents from outpost.hookdeck.com/docs

The API is presently in a static file. Once we have an OpenAPI spec, we can use Zuplo's API reference generator.

All this said, I will experiment with Fern after this.

RabbitMQ and LocalStack tested
@vercel

vercel Bot commented Jan 23, 2025

Copy link
Copy Markdown

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

Name Status Preview Comments Updated (UTC)
outpost ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 23, 2025 4:16pm

@leggetter

Copy link
Copy Markdown
Collaborator Author

@alexbouchardd Since a) I've not changed anything that will impact core code and b) having some docs is better than no docs, I'm going to merge to get the docs. I'll then set up under outpost.hookdeck.com/docs with what we have here. I can then look after Fern as an option.

@leggetter leggetter merged commit 226da95 into main Jan 23, 2025
@leggetter leggetter deleted the feat/docs branch January 23, 2025 16:27
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.

1 participant