There’s some confusion in the documentation due to inconsistent file naming and missing links. Some files are not properly named or linked in the MkDocs configuration, making navigation harder.
Task
Rename Files:
Rename files to follow a clear and consistent naming style (e.g., use lowercase, hyphens, and descriptive names).
Link Unlinked Files:
Add any missing files to the MkDocs config (mkdocs.yml) and ensure they appear in the right section.
Test the Changes:
Run mkdocs serve to check that all links work and the structure is clear.
Result
All files will have clear names and will be properly linked in the documentation.
There’s some confusion in the documentation due to inconsistent file naming and missing links. Some files are not properly named or linked in the MkDocs configuration, making navigation harder.
Task
Rename Files:
Link Unlinked Files:
mkdocs.yml) and ensure they appear in the right section.Test the Changes:
mkdocs serveto check that all links work and the structure is clear.Result
All files will have clear names and will be properly linked in the documentation.
naming format -> kebab case