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

runtime: API documentation #19

Open
littledivy opened this issue Aug 20, 2020 · 4 comments
Open

runtime: API documentation #19

littledivy opened this issue Aug 20, 2020 · 4 comments

Comments

@littledivy
Copy link
Member

Use docosaurus or vuepress for documenting the analyzer

@pauljwil
Copy link

Are you looking for someone to provide documentation for this API? I have taken a couple classes in documenting REST APIs, but I don't have a lot of experience. If you think this would be appropriate for a beginner, I would like to contribute. Thanks!

@littledivy
Copy link
Member Author

That would be awesome @pauljwil ! Thanks for your help. Do you want me to assign you to this issue?

@pauljwil
Copy link

Thanks, @divy-work. Is this a REST API? If so, yes, please assign this issue to me. If it is not, I'm afraid I may not have enough background to understand how to document the API. Assuming it is a REST API, would the goal be to add the documentation to what is currently published at docs.nest.land?

@calidoclette
Copy link

Hello, I can help too.

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

No branches or pull requests

4 participants