-
-
Notifications
You must be signed in to change notification settings - Fork 2
Closed
Labels
bugSomething isn't workingSomething isn't workingdocumentationImprovements or additions to documentationImprovements or additions to documentationenhancementNew feature or requestNew feature or request
Description
📋 Description
While building the MkDocs documentation, the following warnings were encountered regarding missing files and navigation links:
🔍 Missing Documentation Files
- Doc file 'index.md' contains a link 'custom-structures.md', but the target is not found among documentation files.
- Doc file 'index.md' contains a link 'cli-reference.md', but the target is not found among documentation files.
- Doc file 'articles.md' contains a link 'custom-structures.md', but the target is not found among documentation files.
- Doc file 'quickstart.md' contains a link '../example/structure.yaml', but the target is not found among documentation files.
📁 Missing Example Files
In examples/index.md, the following links are pointing to files that do not exist:
- simple-project.yaml
- template-variables.yaml
- remote-files.yaml
- python-project.yaml
- nodejs-api.yaml
- react-frontend.yaml
- microservice.yaml
- terraform-module.yaml
- k8s-application.yaml
- docker-multistage.yaml
- cicd-pipeline.yaml
- monitoring.yaml
- gitops-repo.yaml
- helm-chart.yaml
- multi-environment.yaml
- custom-hooks.yaml
- modular-structure.yaml
🛠️ Suggested Steps to Resolve
- Ensure that all files referenced in the documentation exist in the correct directories.
- Update or correct links pointing to missing files, ensuring their validity.
- Consider creating stubs or placeholder files for missing content where necessary.
- Adjust the MkDocs navigation in
mkdocs.ymlif any erroneous references exist.
📅 Expected Outcome
- No warnings during the MkDocs build process
- All links in the documentation should resolve to valid content
- Improve overall documentation integrity and accessibility
🔗 Related Build Logs
- The warnings originate from the latest build conducted on
2025-08-02T12:19:00Z.
Please review and address these issues to ensure the completeness and accuracy of the documentation.
Metadata
Metadata
Assignees
Labels
bugSomething isn't workingSomething isn't workingdocumentationImprovements or additions to documentationImprovements or additions to documentationenhancementNew feature or requestNew feature or request