Skip to content

Documentation Archive

This directory contains historical documentation, completed plans, and deprecated guides. Documents are archived rather than deleted to preserve institutional knowledge and project history.

📂 Archive Organization

Archives are organized by year and month using the format YYYY-MM/:

archive/
├── 2025-10/          # October 2025 archives
└── README.md         # This file

📋 What Gets Archived?

Documents are moved to the archive when they meet one or more of these criteria:

✅ Completed Work

  • Feature plans that have been fully implemented
  • Bug fix plans that have been resolved and deployed
  • Optimization plans that have been completed

📊 Historical Records

  • Audit reports from specific dates
  • Migration plans that have been executed
  • Temporary fixes that have been superseded

🔄 Superseded Documentation

  • Guides that have been replaced by newer versions
  • Architecture docs that reflect old system design
  • Processes that are no longer in use

🗂️ October 2025 (2025-10/)

Completed Plans

  • memory-optimization.md - Consolidated memory optimization work (completed)
  • performance-optimization.md - Frontend performance improvements (completed)
  • sql-injection-fix.md - BUG-004 SQL injection vulnerability fix (completed)

Historical Records

  • producer-portal-audit.md - Producer portal bug audit from 2025-10-13
  • database-connection-fix.md - Test database connection issue resolution
  • test-fixes-summary.md - Summary of Django test system fixes

🔍 Finding Archived Documentation

By Topic

Use your file explorer or grep to search across archived files:

# Search for content across all archives
grep -r "search term" docs/archive/

# Find files by name pattern
find docs/archive/ -name "*pattern*.md"

By Date

Navigate to the specific month directory if you know approximately when the document was created or archived.

📝 Archiving Guidelines

When archiving documentation:

  1. Determine the appropriate month: Use the month when the work was completed or the document became obsolete
  2. Preserve metadata: Ensure the document retains its original metadata header
  3. Add archive note: Consider adding a note at the top indicating why it was archived
  4. Update references: If active documents reference the archived doc, update those links
  5. Follow naming convention: Rename to kebab-case if not already

Archive Note Template

Add this at the top of archived documents:

> **Archived:** YYYY-MM-DD
> **Reason:** [Completed | Superseded | Deprecated]
> **Replacement:** [Link to new document if applicable]

🔗 Linking to Archives

When referencing archived documentation from active documents, use this format:

See the [archived implementation plan](../archive/2025-10/feature-name.md) for historical context.

⚠️ Important Notes

  • Do not delete archived documents unless they contain sensitive information or violate policy
  • Keep git history intact when moving files to archive
  • Archive is searchable - use it as a knowledge base for past decisions and implementations
  • Update this README when adding new archive directories or significant documents

🆘 Need Help?

  • Looking for active documentation? Check the main docs README
  • Can't find what you need? Try searching git history or ask the team
  • Document incorrectly archived? Create an issue or PR to move it back

Last Updated: 2025-11-01 Maintained By: PiqueTickets Development Team