Fix missing mkdocs-sitemap-plugin dependency

[knowlen]

Summary

Fixes the ReadTheDocs build failure by adding the missing mkdocs-sitemap-plugin dependency.

Problem

After PR #21 added the sitemap plugin to mkdocs.yml, ReadTheDocs builds started failing with:

ERROR   -  Config value 'plugins': The "sitemap" plugin is not installed

Solution

• Added mkdocs-sitemap-plugin>=1.0.0 to docs/requirements.txt (used by ReadTheDocs)
• Added the same dependency to pyproject.toml docs extras for local development consistency

Test Plan

• Dependency added to both files
• Pre-commit hooks pass
• ReadTheDocs build should succeed after merge

This is a critical fix needed to restore documentation builds.

[claude]

Claude finished @knowlen's task —— View job

---

PR Review Complete ✅

Todo List:

• Read changed files to understand the exact dependency additions
• Review mkdocs.yml to understand plugin usage context
• Check version constraints and dependency management consistency
• Assess code quality, security, and best practices
• Provide comprehensive review feedback

---

Review Feedback

✅ Approval - This is a solid dependency fix that addresses the ReadTheDocs build failure correctly.

Code Quality & Best Practices

Excellent consistency:

• The dependency is properly added to both docs/requirements.txt:9 and pyproject.toml:65
• Version constraint >=1.0.0 is identical in both files
• Follows existing pattern of other mkdocs plugin dependencies

Good dependency management:

• Added to the appropriate [project.optional-dependencies] docs section in pyproject.toml
• Maintains separation between ReadTheDocs requirements and local development dependencies
• Version constraint is appropriate for a stable plugin (1.0.0+ is mature)

Security Assessment

No security concerns identified:

• mkdocs-sitemap-plugin is a well-established documentation plugin
• Version constraint >=1.0.0 avoids pre-release versions
• No executable code changes, only dependency declarations

Performance Considerations

Minimal performance impact:

• Sitemap generation happens at build time, not runtime
• Plugin configuration in mkdocs.yml:155-163 includes performance optimizations:
  • minify_css: true
  • remove_comments: true
  • remove_empty_space: true

Context Analysis

Root cause addressed correctly:

• PR Improve SEO visibility for search engines #21 added sitemap plugin to mkdocs.yml but missed the dependency
• This fix ensures the plugin is available in both ReadTheDocs and local development environments
• Plugin is properly configured with SEO-friendly settings (weekly changefreq, 0.5 priority)

Test Coverage

Appropriate for dependency change:

• No unit tests needed for dependency additions
• The real test is successful ReadTheDocs build (mentioned in test plan)
• Pre-commit hooks already passing confirms no syntax issues

Minor Observations

Everything looks good:

• Dependencies are in correct alphabetical order
• Version constraints are reasonable and consistent
• Documentation build environment is properly maintained

Recommendation

✅ Approve and merge - This PR effectively fixes the ReadTheDocs build failure with no risks identified. The dependency addition is handled correctly across both dependency files.

---