chore: Use govydoc to auto generate object docs #48
Conversation
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
Restructures the build system to support a Go workspace with multiple modules and adds automated object documentation generation using govydoc. Updates build tasks to use consistent logging format with _print_step function and improves the developer experience with better formatted output. Adds verification for generated code to ensure it stays in sync with definitions.
Added a "Usage" section to the objectdoc README to clarify the purpose of the generated file and its role in building the OpenSLO website.
- Added `go.work` and `go.work.sum` to the `ignorePaths` list in `cspell.json`. - Included `govydoc` in the `words` list to prevent it from being flagged as a spelling error. - Refactored import statements in `main.go` to group and reorder them for better readability and organization.
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.
TODO