Brief description of the changes made.
- Bug fix (non-breaking change which fixes an issue)
- New feature (non-breaking change which adds functionality)
- Breaking change (fix or feature that would cause existing functionality to not work as expected)
- Documentation update
- Code refactoring
- Performance improvement
If this PR affects any of the following, please ensure documentation is updated:
- New component added → Documentation added to
docs/components/ - Component modified → Documentation updated in
docs/components/ - Component removed → Documentation removed from
docs/components/
- New function added → Documentation added to
docs/functions/ - Function modified → Documentation updated in
docs/functions/ - Function removed → Documentation removed from
docs/functions/
- New configuration option → Documentation added to
docs/configuration/ - Configuration modified → Documentation updated in
docs/configuration/
- New guide needed → Guide added to
docs/guides/ - Existing guide needs update → Guide updated in
docs/guides/
- Breaking API change → Migration guide added to
docs/guides/ - New API endpoint → Documentation added to appropriate section
- Unit tests added/updated
- Integration tests added/updated
- Manual testing completed
- Documentation validation passes (
cargo script scripts/validate-docs.rs --dep walkdir --dep regex) - SQL syntax check passes (
cargo script scripts/check-sql.rs --dep regex --dep walkdir)
Before submitting, please run:
# Validate documentation structure
cargo script scripts/validate-docs.rs --dep walkdir --dep regex
# Check SQL syntax in documentation
cargo script scripts/check-sql.rs --dep regex --dep walkdir
# Check for stale documentation
cargo script scripts/check-stale-docs.rs --dep walkdir --dep regex
# Build documentation database
cargo script scripts/build-simple-db.rs --dep "rusqlite={version=\"0.31\", features=[\"bundled\"]}" --dep walkdir --dep regexAdd screenshots to help explain your changes.
Any additional information that reviewers should know.