Skip to main content

Archive - Legacy Documentation

This directory contains archived documentation for legacy versions of ScrewDrivers (v6 and earlier). Content here is preserved for historical reference and customer support but is not actively maintained.

Purpose​

  • Preserve documentation for customers still running legacy versions
  • Support troubleshooting and migration planning
  • Maintain historical product knowledge
  • Keep legacy content separate from current documentation

Organization​

docs/archive/
├── v6/               # Version 6.x documentation
│   ├── admin-guide/
│   ├── user-guide/
│   └── installation/
├── v5/               # Version 5.x documentation (Simplify Suite)
└── v4/               # Version 4.x documentation

Guidelines​

What Belongs in Archive​

  • Documentation for product versions no longer sold or supported
  • Feature documentation for deprecated functionality
  • Legacy workflows replaced by current processes
  • Historical technical references that may inform migration

What Does NOT Belong in Archive​

  • Release notes - Keep in docs/release-notes/legacy-versions/
  • Known issues - Only if still relevant to supported versions
  • Content applicable to current versions - Update and move to appropriate current location

Adding Content to Archive​

  1. Determine version: Which major version does this content apply to?
  2. Create version folder if it doesn't exist: v6/, v5/, etc.
  3. Organize by content type: admin-guide, user-guide, installation, etc.
  4. Add clear version markers in frontmatter: 
    ---
    title: "Admin Console Layout (v6.x)"
    description: "Legacy admin console layout for ScrewDrivers 6.x"
    tags:
      - archive
      - v6
      - legacy
    ---
  5. Add deprecation notice at the top of each page: 
    :::warning[Legacy Documentation]
    This documentation is for ScrewDrivers v6.x and earlier. For current version
    documentation, see [Administrator Guide](../reference/admin-guide/).
    :::

The archive category is configured with position: 99 and collapsed: true to keep it at the bottom of navigation and collapsed by default. This reduces clutter while keeping content accessible.

To hide completely from sidebar, add to sidebars.js:

// Exclude archive from main sidebar
docs: [
  // ... other items
  {
    type: 'category',
    label: 'Archive',
    items: [],
    customProps: { hidden: true }
  }
]

Maintenance Policy​

  • No active updates: Content is frozen at time of archival
  • Link integrity: Check that internal links still work or point to archive equivalents
  • Security updates: Remove content with security vulnerabilities or outdated credentials
  • Periodic review: Annually review if content is still needed or can be permanently removed

Migration Strategy​

When archiving content from main docs:

  1. Copy, don't move immediately: Keep current content in place until replacement is ready
  2. Add replacement links: In archived content, link to current equivalent
  3. Update cross-references: Find and update references to archived content in current docs
  4. Test links: Verify relative paths work from new location
  5. Document in commit message: Note what was archived and why

Questions?​

For questions about archival policy or what to archive, consult the project documentation in the repository root:

  • guidelines/REFERENCE_STRUCTURE.md - Reference structure guidelines (in project root)
  • CLAUDE.md - Development guidelines (in project root)