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.

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

[Docs]: Add API documentation #1352

Open
ricardomatias opened this issue Sep 19, 2024 · 2 comments
Open

[Docs]: Add API documentation #1352

ricardomatias opened this issue Sep 19, 2024 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@ricardomatias
Copy link

Link to page

No response

Describe the problem

There are a lot of guides and articles, but no actual documentation of the API interface. F.ex: What are the arguments of getTranslations?

@ricardomatias ricardomatias added documentation Improvements or additions to documentation unconfirmed Needs triage. labels Sep 19, 2024
@amannn
Copy link
Owner

amannn commented Sep 19, 2024

I agree that this would be helpful, yes! This will require some thought about how to separate the pages that are rather guides and the ones with API documentation. I think https://react.dev/ does a pretty decent job with this.

@amannn amannn removed the unconfirmed Needs triage. label Sep 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants
@amannn @ricardomatias and others