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

Generate nebula-api documentation via Godoc #202

Open
jpahm opened this issue Feb 21, 2024 · 3 comments
Open

Generate nebula-api documentation via Godoc #202

jpahm opened this issue Feb 21, 2024 · 3 comments
Assignees
Labels
L1 A task suitable for someone who is comfortable helping with basic issues.

Comments

@jpahm
Copy link
Contributor

jpahm commented Feb 21, 2024

This repo would benefit greatly from better, more consistent documentation.

We should look into using Godoc alongside updating and improving the documentation already present in the code.

This should be a fairly easy task, but whoever works on it will need to make sure they understand what they're documenting and should reach out with any questions if uncertainties arise so that documentation is as accurate as possible.

@jpahm jpahm added the L1 A task suitable for someone who is comfortable helping with basic issues. label Feb 21, 2024
@KD-kAnEsHi
Copy link

interested

@jpahm
Copy link
Contributor Author

jpahm commented Aug 31, 2024

interested

You are welcome to work on this! Just note that the documentation that gets generated will probably need to be cleaned up and improved afterwards, which we can talk about later :)

@jpahm
Copy link
Contributor Author

jpahm commented Oct 13, 2024

@KD-kAnEsHi Any updates on this?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
L1 A task suitable for someone who is comfortable helping with basic issues.
Projects
None yet
Development

No branches or pull requests

2 participants