-
Notifications
You must be signed in to change notification settings - Fork 59
Open
Description
Description:
Currently, the documentation includes embedded code examples directly within the markdown files. To improve maintainability and consistency, it would be beneficial to consolidate code examples using Hugo shortcodes. This approach allows code examples to be included from separate files, making it easier to update and manage them.
Proposed Solution:
- Use Hugo's
readFileshortcode to include code examples from separate files. - Organize code examples in a dedicated directory within the repository.
- Update the documentation to reference the code examples using the
readFileshortcode.
Benefits:
- Improved maintainability: Code examples can be updated independently of the documentation.
- Consistency: Ensures that code examples are consistent across different sections of the documentation.
- Clarity: Separates content from code, making the documentation easier to read and navigate.
For more details on how to implement this, please refer to this guide.
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
No labels