Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
145 changes: 50 additions & 95 deletions .github/instructions/.archive/README.md
Original file line number Diff line number Diff line change
@@ -1,118 +1,73 @@
---
title: "Archive Directory"
description: "Contains outdated or superseded documentation files preserved for historical reference"
version: "1.0"
created_date: "2025-12-08"
last_updated: "2025-12-08"
authors: ["LightSpeed Team"]
file_type: "documentation"
domain: "governance"
title: "Archived Instructions"
description: "Deprecated and archived instruction files from consolidation efforts"
status: "archived"
last_updated: "2026-05-31"
domain: "governance"
---

# Archive Directory

This directory contains documentation files that are outdated, superseded, or no longer actively maintained but preserved for historical reference.

## Contents

### Migration Guides (Archived December 8, 2025)
# Archived Instructions

**INSTRUCTION_CONSOLIDATION_MIGRATION.md** (394 lines)
This directory contains deprecated and consolidated instruction files preserved for historical reference. Files in this archive have been superseded by consolidation efforts during Wave 5 documentation audits.

- **Status:** Superseded by `/MIGRATION_GUIDE.md`
- **Purpose:** Documented the December 7, 2025 consolidation of 22 instruction files → 5
- **Reason for archival:** Duplicate content; canonical version exists at repository root
- **Estimated token savings:** ~1,970 tokens
## Archive Contents

**CONSOLIDATION_MIGRATION_GUIDE.md** (387 lines)
### Archived Instruction Files (18 total) - Wave 5 Consolidation

- **Status:** Superseded by `/MIGRATION_GUIDE.md`
- **Purpose:** Migration map for instruction file consolidation
- **Reason for archival:** Duplicate content; canonical version exists at repository root
- **Estimated token savings:** ~1,935 tokens
The following files were consolidated during Wave 5.3 documentation audit (May 2026):

### Consolidated Instruction Files (Archived December 8, 2025)
| File | Status | Consolidation Target |
|------|--------|----------------------|
| `agents.instructions.md` | Archived | Portable `instructions/` files |
| `file-management.instructions.md` | Archived | `instructions/file-organisation.instructions.md` |
| `file-organisation.instructions.md` | Archived | `instructions/file-organisation.instructions.md` |
| `frontmatter.instructions.md` | Archived | `docs/FRONTMATTER_SCHEMA.md` |
| `javascript.instructions.md` | Archived | `instructions/coding-standards.instructions.md` |
| `jest.instructions.md` | Archived | `instructions/testing.instructions.md` |
| `jsdoc.instructions.md` | Archived | `instructions/coding-standards.instructions.md` |
| `json.instructions.md` | Archived | `instructions/coding-standards.instructions.md` |
| `markdown.instructions.md` | Archived | `instructions/documentation-formats.instructions.md` |
| `naming-conventions.instructions.md` | Archived | `instructions/coding-standards.instructions.md` |
| `reporting.instructions.md` | Archived | `.github/reports/` folder structure |
| `reviewer.instructions.md` | Archived | `docs/PR_CREATION_PROCESS.md` |
| `saved-replies.instructions.md` | Archived | `.github/SAVED_REPLIES/` folder |
| `testing.instructions.md` | Archived | `instructions/testing.instructions.md` |
| `tests.instructions.md` | Archived | `instructions/testing.instructions.md` |
| `yaml.instructions.md` | Archived | `instructions/documentation-formats.instructions.md` |
| `CONSOLIDATION_MIGRATION_GUIDE.md` | Archived | Wave 5 Phase 2 execution plan |
| `INSTRUCTION_CONSOLIDATION_MIGRATION.md` | Archived | Wave 5 Phase 2 execution plan |

**21 legacy instruction files consolidated on December 7, 2025:**
### Archival Timeline

These files were the original pre-consolidation instruction files, superseded by 5 new consolidated files:
- **Wave 5.3 (May 2026):** Consolidated 18 instruction files into canonical portable instructions and documentation
- **Retention period:** Files retained for 60 days or until all references updated
- **Removal decision:** Scheduled for review in Wave 5.4

- agents.instructions.md (480 lines, ~2,400 tokens)
- file-management.instructions.md (387 lines, ~1,935 tokens)
- frontmatter.instructions.md (368 lines, ~1,840 tokens)
- javascript.instructions.md (86 lines, ~430 tokens)
- jest.instructions.md (47 lines, ~235 tokens)
- jsdoc.instructions.md (550 lines, ~2,750 tokens)
- json.instructions.md (97 lines, ~485 tokens)
- markdown.instructions.md (186 lines, ~930 tokens)
- mermaid.instructions.md (371 lines, ~1,855 tokens)
- metrics.instructions.md (53 lines, ~265 tokens)
- naming-conventions.instructions.md (46 lines, ~230 tokens)
- planner.instructions.md (61 lines, ~305 tokens)
- project-meta-sync.instructions.md (50 lines, ~250 tokens)
- readme.instructions.md (160 lines, ~800 tokens)
- release.instructions.md (218 lines, ~1,090 tokens)
- reporting.instructions.md (297 lines, ~1,485 tokens)
- reviewer.instructions.md (76 lines, ~380 tokens)
- saved-replies.instructions.md (90 lines, ~450 tokens)
- testing.instructions.md (203 lines, ~1,015 tokens)
- tests.instructions.md (273 lines, ~1,365 tokens)
- yaml.instructions.md (84 lines, ~420 tokens)
## How to Use This Archive

**Total legacy instructions:** 4,161 lines, ~20,805 tokens
### If You Find a Reference to an Archived File

**Superseded by:**
1. Locate the consolidation target in the table above
2. Update your reference to point to the canonical location
3. File an issue if content is missing from the new location

- `.github/instructions/languages.instructions.md` (consolidated: javascript, jsdoc, json, yaml)
- `.github/instructions/documentation-formats.instructions.md` (consolidated: markdown, frontmatter, mermaid)
- `.github/instructions/quality-assurance.instructions.md` (consolidated: testing, tests, jest)
- `.github/instructions/automation.instructions.md` (consolidated: agents, metrics, planner, project-meta-sync, release, reporting, reviewer)
- `.github/instructions/community-standards.instructions.md` (consolidated: file-management, naming-conventions, readme, saved-replies)
### If You Need Old Guidance

### Backup Files (Archived December 8, 2025)
1. Check the replacement file/location first
2. If content is missing, file an issue requesting it be restored
3. Do not rely on archived files as sources of truth

**FRONTMATTER_SCHEMA.md.backup** (989 lines)
## Canonical References

- **Purpose:** Backup before Phase 6.2 duplicate section removal
- **Estimated token savings:** ~4,945 tokens
For current instruction files, see:

**ISSUE_TYPES.md.backup** (952 lines)

- **Purpose:** Backup before Phase 6.1 consolidation
- **Estimated token savings:** ~4,760 tokens

**WORKFLOWS.md.backup** (657 lines)

- **Purpose:** Backup before Phase 6.4 title clarification
- **Estimated token savings:** ~3,285 tokens

**Total Phase 5 Archival:** 3,379 lines, ~16,895 tokens saved
- **Portable instructions:** `/instructions/` (top-level)
- **Documentation:** `/docs/` (human-facing reference)
- **Repo-local instructions:** `./.github/instructions/` (this repo only)

---

## Accessing Archived Files

Archived files remain in the repository for historical reference. To access:

```bash
cd docs/.archive
cat FILENAME.md
```

## Canonical Versions

For current documentation, always reference:

- **Migration Guide:** `/MIGRATION_GUIDE.md` (canonical version)
- **All Instructions:** `.github/instructions/*.instructions.md` (consolidated files)

---

*This archive was created as part of Phase 5 context reduction efforts (December 2025) to reduce repository token count from ~922K to <500K target.*

*Have questions? Ping us on GitHub! 🐙 Made with 💚 by LightSpeedWP*
[Contact](https://lightspeedwp.agency/contact)

*Have questions? Ping us on GitHub! 🐙 Made with 💚 by LightSpeedWP*
[Contact](https://lightspeedwp.agency/contact)
**Archive Created:** May 2026 (Wave 5.3 Consolidation)
**Last Updated:** 2026-05-31
**Archiver:** Claude Code (Wave 5.3 Phase 2 Execution)
5 changes: 0 additions & 5 deletions .github/instructions/file-organisation.instructions.md

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -81,21 +81,19 @@ Audited 6 documentation files related to issue creation. Found:

### 2. **`docs/ISSUE_LABELS.md`**

**Status:** ❌ **DOES NOT EXIST**
**Status:** ❌ **DEPRECATED & CONSOLIDATED**

Referenced in audit scope (#662) but file is missing. This is a critical gap:
Referenced in audit scope but this file was consolidated into `docs/LABELING.md` (see `instructions/DEPRECATED.md`).

- No canonical source for label names, colors, or strategies
- Label guidance split across multiple files
- Could cause contributor confusion
**Key Finding:**

**Should be created to consolidate:**
- `docs/LABELING.md` already contains the comprehensive labelling guide
- Includes "Issue Labelling" section (section 3) with all required information
- Label families, colors, automation rules already documented there
- References to the old `ISSUE_LABELS.md` should be updated to point to `LABELING.md`

- Label families (status, priority, type, area, comp, meta, contrib, context)
- One-hot rules
- Color palette
- Label assignment automation rules
- Examples per label family
**Recommendation:**
Instead of creating a new file, update all broken references to `ISSUE_LABELS.md` to point to `docs/LABELING.md#issue-labelling` instead.

---

Expand Down Expand Up @@ -205,7 +203,7 @@ Referenced in audit scope (#662) but file is missing. This is a critical gap:
| Current File | Content | Proposed Location | Action | Rationale |
|--------------|---------|-------------------|--------|-----------|
| `docs/ISSUE_CREATION_GUIDE.md` | Practical how-to guide | Keep (docs/) | Preserve | Good audience fit, clear structure |
| `docs/ISSUE_LABELS.md` | Missing label reference | Create (docs/) | Create | Critical gap; consolidate label strategy |
| `docs/ISSUE_LABELS.md` | Deprecated; consolidated into LABELING.md | Update references | Fix broken links | Already exists at `docs/LABELING.md#issue-labelling`; redirect references there |
| `docs/ISSUE_TYPES.md` | Type definitions & reference | Keep (docs/) | Preserve | Comprehensive, well-maintained |
| `.github/ISSUE_TEMPLATE/README.md` | Template directory guide | Migrate to inline comments | Archive or migrate | Mostly metadata; can live in directory |
| `instructions/issues.instructions.md` | Official instructions | Refactor | Consolidate & fix | Remove internal duplication; keep authoritative core |
Expand Down Expand Up @@ -255,7 +253,7 @@ Referenced in audit scope (#662) but file is missing. This is a critical gap:

**Content:** What labels are required, label families, one-hot rules

**Consolidation:** Create `docs/ISSUE_LABELS.md` and reference it everywhere
**Consolidation:** Redirect references to `docs/LABELING.md#issue-labelling` and do not recreate the deprecated file

---

Expand All @@ -277,23 +275,22 @@ Referenced in audit scope (#662) but file is missing. This is a critical gap:

### Critical Gaps

1. **`docs/ISSUE_LABELS.md`** (Missing)
- Should cover all label families
- Should list all labels with colors
- Should explain one-hot rules
- Should reference `labels.yml` and `labeler.yml`
- Impact: High — referenced but doesn't exist
1. **Broken references to `docs/ISSUE_LABELS.md`**
- `instructions/issues.instructions.md` section 4 references deprecated file
- File was consolidated into `docs/LABELING.md` (per `instructions/DEPRECATED.md`)
- References should point to `docs/LABELING.md#issue-labelling` instead
- Impact: High — broken links to deprecated location

2. **`docs/index.md`** (Empty)
- Should be actual index with links
- Currently just placeholder
- Impact: Medium — documentation discoverability

3. **docs/ISSUE_LABELS.md references in instructions**
- `instructions/issues.instructions.md` section 4 references this
- File does not exist
- Creates broken reference chains
- Impact: High — broken links
3. **Clarify labeling documentation location**
- All label families, colors, and automation rules are in `docs/LABELING.md`
- Not in a separate ISSUE_LABELS.md (which was deprecated)
- Update cross-references to point to consolidated guide
- Impact: High — reducing confusion around document organization

---

Expand All @@ -306,22 +303,21 @@ Referenced in audit scope (#662) but file is missing. This is a critical gap:
- Keep authoritative version only
- Preserve formatting and structure

2. **Create `docs/ISSUE_LABELS.md`** (new file)
- List all label families and allowed values
- Reference `labels.yml` and `labeler.yml`
- Explain one-hot rules
- Provide color palette
- Include examples per family
2. **Update broken references to ISSUE_LABELS.md**
- Locate all references to the deprecated `docs/ISSUE_LABELS.md`
- Redirect them to `docs/LABELING.md#issue-labelling` instead
- Note: The file was consolidated into `docs/LABELING.md` (see `instructions/DEPRECATED.md`)
- Do NOT recreate the deprecated file

3. **Update `docs/index.md`**
- Create actual documentation index
- Link to all issue-related files
- Link to all issue-related files (including `LABELING.md`)
- Add brief descriptions and use cases

### Phase 2: Align & Link (Wave 5.3 or 5.4)

1. **Update cross-references**
- Ensure all files link to `docs/ISSUE_LABELS.md` (once created)
- Ensure all files link to `docs/LABELING.md#issue-labelling`
- Verify no broken references
- Use consistent link patterns

Expand Down Expand Up @@ -362,7 +358,7 @@ Referenced in audit scope (#662) but file is missing. This is a critical gap:

1. **Phase 1 (Immediate):**
- [ ] Fix `instructions/issues.instructions.md` duplication
- [ ] Create `docs/ISSUE_LABELS.md` with full label reference
- [ ] Update all broken references to point to `docs/LABELING.md#issue-labelling`
- [ ] Update `docs/index.md` with proper index

2. **Phase 2 (Follow-up):**
Expand Down
Loading
Loading