Added API docs generation instructions to README.md #40
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I fixed a few things for our website docs today, and tried to update the API Reference.
I tried a few options to generate API references directly from .proto file, and this default method works the most smooth, so I’m adding it here. The generated HTML version looks nice, and markdown is okay.
My goal is to find an automatic way to update docs from the .proto file so we can rapidly update the API reference on our website /docs.
Although the documentation can now be generated, I haven’t added it to the website yet. This is because many input fields still require detailed explanations, and we need to organize the definitions by command groups to create a more user-friendly structure. I believe updating the .proto file and leveraging the protoc-gen-doc plugin can help achieve this, but I suggest we focus on testing the APIs in the Studio first before finalizing the structure.
Generated HTML screenshot
