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.

Sign up for GitHub

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

Jump to bottom

Document new API #803

Open
driesvints opened this issue Jan 8, 2022 · 4 comments
Open

Document new API #803

driesvints opened this issue Jan 8, 2022 · 4 comments
Labels
enhancement

Comments

@driesvints
Copy link
Member

We should add some documentation for the new API sent in at #793.

I'm not sure if we should use a certain API documentation tool or just try to incorporate it into the current design.
@driesvints driesvints mentioned this issue Jan 8, 2022
Merged
@joelbutcher
Copy link
Contributor

@driesvints could use Nextra and host it on Vercel? It's all .mdx docs

@driesvints
Copy link
Member Author

@joelbutcher Thanks but I'd like to take my time thinking about this and doing some research on some tooling before we reach a decision.

@spoyntersmith
Copy link

I'm used to using scribe for Laravel projects if that helps, can be updated as part of a deployment

https://scribe.readthedocs.io/en/latest/

@driesvints
Copy link
Member Author

Yeah that could maybe be a viable one.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement
Milestone
No milestone
Development

No branches or pull requests
3 participants
@driesvints @joelbutcher @spoyntersmith