📚 Fix MkDocs build warnings by addressing missing files and links#81
Merged
📚 Fix MkDocs build warnings by addressing missing files and links#81
Conversation
Resolves #79 This commit addresses the MkDocs build warnings related to missing files and broken links: ## Files Added: - ✅ docs/custom-structures.md - Comprehensive guide on creating and using custom structures - ✅ docs/cli-reference.md - Complete CLI reference with all commands, options, and examples ## Files Updated: - ✅ docs/examples/index.md - Replaced all broken file references with inline YAML examples - ✅ Fixed Jinja2 template syntax to match struct's custom configuration ({{@ variable @}}) ## Key Improvements: - Eliminated all MkDocs warnings for missing documentation files - Added practical, copy-paste ready examples with proper Jinja2 syntax - Created comprehensive CLI documentation with usage examples - Improved overall documentation completeness and usability All examples use the correct template syntax as defined in struct_module/template_renderer.py
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #81 +/- ##
=======================================
Coverage 68.74% 68.74%
=======================================
Files 23 23
Lines 1331 1331
Branches 181 181
=======================================
Hits 915 915
Misses 374 374
Partials 42 42 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
- Added 22+ documentation pages to sitemap for better SEO coverage - Included all existing generated HTML pages from site/docs/ - Added entries for new CLI reference and custom structures pages - All pages configured with proper SEO attributes (lastmod, changefreq, priority) - Created update-sitemap.sh script for future maintenance Sitemap now covers: - Configuration, hooks, development guides - Template variables, examples, file handling - Installation, usage, contributing docs - GitHub integration, schemas, mappings - And all other generated documentation pages Total URLs: 29 (up from ~7), Documentation pages: 26
…rnal links and improving URL formatting in scripts
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
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.
🔧 Fixes Issue #79
This PR addresses the MkDocs build warnings related to missing files and broken links identified in issue #79.
📋 Changes Made
✅ Files Added:
docs/custom-structures.md- Comprehensive guide on creating and using custom structuresdocs/cli-reference.md- Complete CLI reference with all commands, options, and practical examples✅ Files Updated:
docs/examples/index.md- Replaced all broken file references with inline YAML examples{{@ variable @}})🛠️ Key Improvements
Documentation Completeness
custom-structures.md(referenced inindex.mdandarticles.md)cli-reference.md(referenced inindex.md)docs/examples/index.mdExample Quality
struct_module/template_renderer.pyCLI Documentation
info,validate,generate,list,generate-schema)🧪 Testing
{{@ variable @}}) as configured in the template renderer📅 Expected Outcome
Ready for review! This should resolve all the missing file warnings mentioned in the build logs from
2025-08-02T12:19:00Z.