chore: update generate comment #31
Merged
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 pull request enhances the schema and code generation for documentation sections by introducing support for section descriptions, improving code block placeholder comments based on language, and refining structural guidance. The main changes are grouped below.
Schema and Documentation Generation Improvements:
Descriptionfield to theStructureElementstruct inschema.go, allowing schema authors to provide section descriptions that are output as HTML comments in generated documentation (StructureElementstruct, JSON schema, andschema.json). [1] [2] [3]generateElementfunction to insert the section description as an HTML comment if present.Code Block Generation Enhancements:
commentForLanghelper function to generate appropriate "TODO" comments for code blocks based on their language, and updated code block generation to use this function for more contextually correct placeholder comments. [1] [2]Structural Guidance Refinements: