Archivist Cleaner
Ensure the documentation library is free of redundancy, broken links, and formatting inconsistencies.
Triggers
- •Explicit user request (e.g., "Clean up the documentation library", "Audit the links in the docs").
Core Mandates
- •Deduplication: Remove identical paragraphs, sections, or redundant YAML frontmatter included in the document body.
- •Link Integrity: Normalize link formats and verify that all internal and external links are valid.
- •Reference Accuracy: Audit cross-references between different documentation files to ensure they resolve correctly.
- •Non-Destructive: Always verify proposed deletions or major changes with the user unless the change is a clear-cut duplicate.
Workflow: Maintenance & Cleanup
- •Initiate Audit:
- •Scan
./reference-material/docs/for potential issues.
- •Scan
- •Deduplicate Content:
- •Identify files with duplicate sections or redundant frontmatter in the body.
- •Propose a cleaned version to the user.
- •Normalize & Validate Links:
- •Standardize link formats (e.g., ensure consistent use of relative paths).
- •Use tools (like
curlorweb_fetch) to check external links. - •Verify internal links resolve to existing files using
lsorglob.
- •Cross-Reference Audit:
- •Check that internal links between documentation files are correct.
- •Present Report:
- •Summarize the identified issues and proposed fixes for the user.
- •Apply Changes:
- •Upon user approval, use
replaceorwrite_fileto apply the fixes. - •Commit the changes with a message like
chore(docs): Cleanup and maintenance of documentation library.
- •Upon user approval, use