feat: introduce GoDoc-based documentation generation and initial docs#649
Open
JrSchmidtt wants to merge 2 commits into
Open
feat: introduce GoDoc-based documentation generation and initial docs#649JrSchmidtt wants to merge 2 commits into
JrSchmidtt wants to merge 2 commits into
Conversation
- Introduced a new tool for generating API documentation from Go source code. - Created a `gendocs.go` file that processes specified packages and generates Markdown files. - Added an initial API documentation file for the root package.
|
Has anyone thought about creating a mind map on https://obsidian.md/? |
This file contains hidden or 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
2 participants
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.
This merge request introduces the use of GoDoc to automatically generate documentation for public methods and interfaces.
This is a proposal for a standardized documentation format. GoDoc was chosen because it is the official documentation tool for Go, widely adopted by the community, and designed to keep documentation close to the source code.
Using GoDoc reduces manual maintenance, improves consistency, and ensures documentation remains up to date as the code evolves.
It also enables exporting the generated documentation to Markdown format for external usage.
For more details on GoDoc and its benefits, see: https://go.dev/doc/comment
How to Review
index.mdfile, which contains links to all auto-generated module documentation.src/tools/gendocs.gois responsible for generating the documentation in Markdown format.