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

Add documentation #98

Closed
wants to merge 1 commit into from
Closed

Add documentation #98

wants to merge 1 commit into from

Conversation

ghost
Copy link

@ghost ghost commented Oct 18, 2021

Description of changes proposed in this pull request:

Checks:

  • Have you followed the guidelines in our Contributing document?
  • Have you checked to ensure there aren't other open Pull Requests for the same update/change?

@ghost ghost added the can merge label Oct 18, 2021
@ghost ghost self-assigned this Oct 18, 2021
@ghost ghost requested a review from ethedev October 18, 2021 19:48
@ghost ghost linked an issue Oct 18, 2021 that may be closed by this pull request
API: Add godoc #92
Open
@ethedev ethedev changed the base branch from master to develop October 19, 2021 10:39
ethedev
ethedev requested changes Oct 19, 2021
View reviewed changes
Copy link
Member

@ethedev ethedev left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@byterose we need to have at least one endpoint example documentation before proceeding on this

@ghost
Copy link
Author

ghost commented Oct 19, 2021

@ethedev So you want to have an endpoint for the entire documentation?
I would say that we should keep it as it is, so people can generate the documentation themselves, since it is very technical.

@ghost
Copy link
Author

ghost commented Oct 19, 2021

I also added something to the readme, so everyone is able to generate the documentation.

@ethedev
Copy link
Member

ethedev commented Oct 20, 2021

@byterose we dont need from people to generate the documentation, we will generate it and keep it always up to date after adding, updating or changing endpoints

@ethedev ethedev closed this Jul 16, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
cannot merge
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

API: Add godoc
1 participant
@ethedev