@legioncodeinc/rflectr 0.1.0 → 0.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -5
- package/dist/cli.js +1 -1
- package/library/README.md +39 -39
- package/library/issues/README.md +46 -46
- package/library/issues/backlog/README.md +26 -26
- package/library/issues/completed/README.md +13 -13
- package/library/issues/in-work/README.md +13 -13
- package/library/knowledge/README.md +34 -34
- package/library/knowledge/private/README.md +40 -40
- package/library/knowledge/private/standards/documentation-framework.md +154 -154
- package/library/knowledge/public/README.md +49 -49
- package/library/notes/README.md +21 -21
- package/library/requirements/README.md +51 -51
- package/library/requirements/backlog/README.md +30 -30
- package/library/requirements/completed/README.md +14 -14
- package/library/requirements/completed/prd-002-provider-registry/prd-002-provider-registry-index.md +263 -0
- package/library/requirements/completed/prd-003-model-discovery-classification/prd-003-model-discovery-classification-index.md +260 -0
- package/library/requirements/completed/prd-004-translation-layer/prd-004-translation-layer-index.md +196 -0
- package/library/requirements/completed/prd-005-local-proxy-catalog-routing/prd-005-local-proxy-catalog-routing-index.md +176 -0
- package/library/requirements/completed/prd-006-credential-storage/prd-006-credential-storage-index.md +190 -0
- package/library/requirements/completed/prd-006-credential-storage/qa/.gitkeep +0 -0
- package/library/requirements/completed/prd-007-oauth-device-flows/prd-007-oauth-device-flows-index.md +208 -0
- package/library/requirements/completed/prd-008-preferences-tiers-favorites/prd-008-preferences-tiers-favorites-index.md +249 -0
- package/library/requirements/completed/prd-008-preferences-tiers-favorites/qa/.gitkeep +0 -0
- package/library/requirements/completed/prd-009-codex-integration/prd-009-codex-integration-index.md +212 -0
- package/library/requirements/completed/prd-009-codex-integration/qa/.gitkeep +0 -0
- package/library/requirements/completed/prd-010-gemini-cli-integration/prd-010-gemini-cli-integration-index.md +211 -0
- package/library/requirements/completed/prd-010-gemini-cli-integration/qa/.gitkeep +0 -0
- package/library/requirements/completed/prd-011-claude-desktop-integration/prd-011-claude-desktop-integration-index.md +228 -0
- package/library/requirements/completed/prd-012-server-gateway/prd-012-server-gateway-index.md +356 -0
- package/library/requirements/completed/prd-012-server-gateway/qa/.gitkeep +0 -0
- package/library/requirements/in-work/README.md +19 -19
- package/library/requirements/reports/README.md +31 -31
- package/package.json +1 -1
|
@@ -1,154 +1,154 @@
|
|
|
1
|
-
# Documentation Framework
|
|
2
|
-
|
|
3
|
-
> Category: Standards | Version: 1.0 | Date: (fill in on init) | Status: Canonical
|
|
4
|
-
|
|
5
|
-
The single source of truth for how documentation is written in this repository. Every document — feature PRDs, issue PRDs, QA reports, architecture docs, API references, guides — must conform to the standards defined here. If a document type is not covered, add a new section to this file rather than inventing a local convention.
|
|
6
|
-
|
|
7
|
-
---
|
|
8
|
-
|
|
9
|
-
## 1. Document Types
|
|
10
|
-
|
|
11
|
-
| Type | Purpose | Location | Primary audience |
|
|
12
|
-
|---|---|---|---|
|
|
13
|
-
| **Issue IRD** | Implementation plan for a specific GitHub issue | `library/requirements/issues/issue-<###>-<title>/ird-issue-<###>-<title>.md` | Implementation engineer |
|
|
14
|
-
| **Feature PRD** | Planned feature spec (forward or retroactive) | `library/requirements/features/feature-<###>-<title>/prd-feature-<###>-<title>.md` (or `prd-feature-<###>-<title>-ck-<clickupId>.md` if from ClickUp) | Implementation engineer |
|
|
15
|
-
| **QA Report (tied)** | Audit of an implementation against its plan | The plan's own `reports/<date>-qa-report.md` subfolder | Team lead, author of the feature |
|
|
16
|
-
| **QA Report (standalone)** | Audit not tied to a single plan | `library/qa/<domain>/<date>-qa-report.md` | Team lead, audit reviewer |
|
|
17
|
-
| **Architecture Doc** | System design, data flows, component relationships | `library/knowledge-base/architecture/` | Senior engineers, architects |
|
|
18
|
-
| **API Reference** | Endpoint-by-endpoint documentation with schemas | `library/knowledge-base/api/` | Frontend devs, API consumers |
|
|
19
|
-
| **How-to Guide** | Runbooks for setup, testing, deploying, adding features | `library/knowledge-base/how-to-guides/` | New engineers, DevOps |
|
|
20
|
-
| **Integration Doc** | Third-party service configuration and error handling | `library/knowledge-base/integrations/` | DevOps, engineers wiring services |
|
|
21
|
-
| **UX/UI Standard** | Visual design language — tokens, components, patterns | `library/knowledge-base/design/` | Designers, frontend devs |
|
|
22
|
-
| **Feature Doc** | Completed feature reference (post-ship) | `library/knowledge-base/features/` | Any engineer joining the project |
|
|
23
|
-
| **Spec** | Feature-level handoff spec for a UI flow | `library/knowledge-base/specs/` | Frontend engineers |
|
|
24
|
-
| **Product Brief** | Product vision, scope, roadmap | `library/knowledge-base/product/` | Team, stakeholders |
|
|
25
|
-
| **Standards Doc** | Rules for writing documentation itself | `library/knowledge-base/standards/` | All contributors |
|
|
26
|
-
| **Release Notes** | What changed in each release | `library/knowledge-base/releases/` | All team members |
|
|
27
|
-
|
|
28
|
-
---
|
|
29
|
-
|
|
30
|
-
## 2. Universal Document Header
|
|
31
|
-
|
|
32
|
-
Every markdown file under `library/knowledge-base/` starts with:
|
|
33
|
-
|
|
34
|
-
```markdown
|
|
35
|
-
# <Document Title>
|
|
36
|
-
|
|
37
|
-
> Category: <Type> | Version: <X.Y> | Date: <Month YYYY> | Status: <Active | Draft | Archived>
|
|
38
|
-
|
|
39
|
-
<One-sentence description of what this document covers and who should read it.>
|
|
40
|
-
|
|
41
|
-
**Related:**
|
|
42
|
-
- [Link to related doc]
|
|
43
|
-
- [Link to source code: `src/path/to/file.ts`]
|
|
44
|
-
```
|
|
45
|
-
|
|
46
|
-
- **Version** — starts at `1.0`; patch bumps (`1.0` → `1.1`) for additions, minor bumps (`1.x` → `2.0`) for reorganizations.
|
|
47
|
-
- **Date** — current month/year on the last meaningful edit.
|
|
48
|
-
- **Status** values:
|
|
49
|
-
- `Active` — current, should be kept up to date
|
|
50
|
-
- `Draft` — work in progress, not authoritative
|
|
51
|
-
- `Archived` — historical, no longer maintained
|
|
52
|
-
- `Canonical` — (for standards docs only) highest authority; overrides ad-hoc conventions
|
|
53
|
-
|
|
54
|
-
Requirements-type docs (issue IRDs, feature PRDs, QA reports) use a different header format documented in their respective guides.
|
|
55
|
-
|
|
56
|
-
---
|
|
57
|
-
|
|
58
|
-
## 3. Filename Conventions
|
|
59
|
-
|
|
60
|
-
| Document type | Folder + filename pattern | Example |
|
|
61
|
-
|---|---|---|
|
|
62
|
-
| Issue IRD | `issue-<###>-<title>/ird-issue-<###>-<title>.md` (with sibling `reports/`) | `issue-046-stale-cached-responses/ird-issue-046-stale-cached-responses.md` |
|
|
63
|
-
| Feature PRD | `feature-<###>-<title>/prd-feature-<###>-<title>.md` (with sibling `reports/`) | `feature-007-user-profile-export/prd-feature-007-user-profile-export.md` |
|
|
64
|
-
| Feature PRD (from ClickUp) | `feature-<###>-<title>/prd-feature-<###>-<title>-ck-<clickupId>.md` | `feature-007-user-profile-export/prd-feature-007-user-profile-export-ck-86c8wq2k1.md` |
|
|
65
|
-
| QA report (tied to plan) | `<plan-folder>/reports/<date>-qa-report.md` | `feature-007-user-profile-export/reports/2026-04-26-qa-report.md` |
|
|
66
|
-
| QA report (standalone) | `library/qa/<domain>/<date>-qa-report.md` | `library/qa/auth/2026-04-26-qa-report.md` |
|
|
67
|
-
| Knowledge-base | `<domain>/<kebab-slug>.md` (no numeric prefix) | `architecture/authentication-flow.md` |
|
|
68
|
-
|
|
69
|
-
**Numbering rules:**
|
|
70
|
-
- `<###>` is **3-digit zero-padded** (`006`, `046`, `093`, `100`). 4+ digit natural width.
|
|
71
|
-
- Issue numbers follow the GitHub issue number.
|
|
72
|
-
- Feature numbers are repo-local sequential; take `max + 1` from existing folders (open + `completed/`).
|
|
73
|
-
- Titles are lowercase kebab-case, ≤60 chars.
|
|
74
|
-
- The optional ClickUp suffix `-ck-<clickupId>` goes on the **main file only**, never on the folder name.
|
|
75
|
-
|
|
76
|
-
---
|
|
77
|
-
|
|
78
|
-
## 4. Folder Location Rules
|
|
79
|
-
|
|
80
|
-
| Folder | Meaning |
|
|
81
|
-
|---|---|
|
|
82
|
-
| `library/requirements/features/feature-<###>-<title>/` | Feature work in progress. |
|
|
83
|
-
| `library/requirements/features/completed/feature-<###>-<title>/` | Feature has shipped. Move the entire folder (PRD + `reports/`). |
|
|
84
|
-
| `library/requirements/issues/issue-<###>-<title>/` | Issue work in progress (GitHub issue OPEN). |
|
|
85
|
-
| `library/requirements/issues/completed/issue-<###>-<title>/` | Issue has been resolved (GitHub issue CLOSED). Move the entire folder (IRD + `reports/`). Symmetric to features. |
|
|
86
|
-
| `<plan-folder>/reports/` | QA reports tied to that specific feature/issue. Travel with the folder when it moves. |
|
|
87
|
-
| `library/qa/<domain>/` | Standalone QA reports — broad audits not tied to a single plan. |
|
|
88
|
-
|
|
89
|
-
Move folders when status changes. Never edit lifecycle state in frontmatter alone.
|
|
90
|
-
|
|
91
|
-
---
|
|
92
|
-
|
|
93
|
-
## 5. Writing Rules (all doc types)
|
|
94
|
-
|
|
95
|
-
1. **Ground every claim in code.** Quote source with file path + line range; never paraphrase signatures.
|
|
96
|
-
2. **One topic per document.** Split if a doc exceeds ~500 lines.
|
|
97
|
-
3. **Progressive disclosure.** Open with "why this exists" and "who should read it"; deep details below.
|
|
98
|
-
4. **Link out, don't duplicate.** If another doc covers a subtopic, link to it.
|
|
99
|
-
5. **Diagrams use mermaid.** Prefer `flowchart TD` or `sequenceDiagram`. No explicit colors.
|
|
100
|
-
6. **No time-sensitive language.** Avoid "currently", "recently", "as of". Use explicit dates.
|
|
101
|
-
7. **No personal opinions.** Docs describe decisions and rationale, not preferences.
|
|
102
|
-
|
|
103
|
-
---
|
|
104
|
-
|
|
105
|
-
## 6. Cross-Linking Conventions
|
|
106
|
-
|
|
107
|
-
- Use relative paths: `[title](../relative/path.md)`.
|
|
108
|
-
- Link to code with file paths (and line numbers where useful): `` `src/routes/users.ts:42-80` ``.
|
|
109
|
-
- PRDs and IRDs link to their related issues, features, and QA reports in a **Related** section at the end.
|
|
110
|
-
- Knowledge-base docs link to the PRDs that drove them (when applicable) and to source code.
|
|
111
|
-
|
|
112
|
-
---
|
|
113
|
-
|
|
114
|
-
## 7. Diagram Rules
|
|
115
|
-
|
|
116
|
-
- Mermaid preferred (renders everywhere GitHub does).
|
|
117
|
-
- Use `flowchart TD` (top-down) for process flows; `sequenceDiagram` for temporal flows; `erDiagram` for data models.
|
|
118
|
-
- Node IDs: no spaces (use `camelCase` or `under_scores`).
|
|
119
|
-
- No explicit colors (breaks dark mode).
|
|
120
|
-
- No `click` events.
|
|
121
|
-
- Quote labels containing parentheses, brackets, or colons.
|
|
122
|
-
|
|
123
|
-
---
|
|
124
|
-
|
|
125
|
-
## 8. Versioning + Dates
|
|
126
|
-
|
|
127
|
-
- **Versioning** is per-document, not repo-wide. Bump on meaningful content change.
|
|
128
|
-
- **Dates** use the current month/year (from the system clock), not arbitrary timestamps.
|
|
129
|
-
- Each document optionally ends with a **Changelog** section listing version bumps.
|
|
130
|
-
|
|
131
|
-
---
|
|
132
|
-
|
|
133
|
-
## 9. Ownership
|
|
134
|
-
|
|
135
|
-
- Requirements docs (issue IRDs, feature PRDs) are owned by the implementation author. QA reports are owned by `quality-guardian`.
|
|
136
|
-
- Knowledge-base docs are owned by the team collectively — anyone may edit with a PR.
|
|
137
|
-
- Standards docs (this file included) require team consensus before changing.
|
|
138
|
-
|
|
139
|
-
---
|
|
140
|
-
|
|
141
|
-
## 10. Bootstrap — After `initialize`
|
|
142
|
-
|
|
143
|
-
When `library-guardian initialize` seeds a repo:
|
|
144
|
-
|
|
145
|
-
1. Replace the placeholder "(fill in on init)" in the header above with the current month/year.
|
|
146
|
-
2. Replace any project-name placeholders in the seeded README files with your repo's actual name.
|
|
147
|
-
3. Edit any section of this framework that doesn't match your team's conventions — then commit.
|
|
148
|
-
4. Start using the agent: ingest issues, plan features, document architecture.
|
|
149
|
-
|
|
150
|
-
---
|
|
151
|
-
|
|
152
|
-
## Changelog
|
|
153
|
-
|
|
154
|
-
- v1.0 — Initial template seeded by `library-guardian`. Customize per repo.
|
|
1
|
+
# Documentation Framework
|
|
2
|
+
|
|
3
|
+
> Category: Standards | Version: 1.0 | Date: (fill in on init) | Status: Canonical
|
|
4
|
+
|
|
5
|
+
The single source of truth for how documentation is written in this repository. Every document — feature PRDs, issue PRDs, QA reports, architecture docs, API references, guides — must conform to the standards defined here. If a document type is not covered, add a new section to this file rather than inventing a local convention.
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## 1. Document Types
|
|
10
|
+
|
|
11
|
+
| Type | Purpose | Location | Primary audience |
|
|
12
|
+
|---|---|---|---|
|
|
13
|
+
| **Issue IRD** | Implementation plan for a specific GitHub issue | `library/requirements/issues/issue-<###>-<title>/ird-issue-<###>-<title>.md` | Implementation engineer |
|
|
14
|
+
| **Feature PRD** | Planned feature spec (forward or retroactive) | `library/requirements/features/feature-<###>-<title>/prd-feature-<###>-<title>.md` (or `prd-feature-<###>-<title>-ck-<clickupId>.md` if from ClickUp) | Implementation engineer |
|
|
15
|
+
| **QA Report (tied)** | Audit of an implementation against its plan | The plan's own `reports/<date>-qa-report.md` subfolder | Team lead, author of the feature |
|
|
16
|
+
| **QA Report (standalone)** | Audit not tied to a single plan | `library/qa/<domain>/<date>-qa-report.md` | Team lead, audit reviewer |
|
|
17
|
+
| **Architecture Doc** | System design, data flows, component relationships | `library/knowledge-base/architecture/` | Senior engineers, architects |
|
|
18
|
+
| **API Reference** | Endpoint-by-endpoint documentation with schemas | `library/knowledge-base/api/` | Frontend devs, API consumers |
|
|
19
|
+
| **How-to Guide** | Runbooks for setup, testing, deploying, adding features | `library/knowledge-base/how-to-guides/` | New engineers, DevOps |
|
|
20
|
+
| **Integration Doc** | Third-party service configuration and error handling | `library/knowledge-base/integrations/` | DevOps, engineers wiring services |
|
|
21
|
+
| **UX/UI Standard** | Visual design language — tokens, components, patterns | `library/knowledge-base/design/` | Designers, frontend devs |
|
|
22
|
+
| **Feature Doc** | Completed feature reference (post-ship) | `library/knowledge-base/features/` | Any engineer joining the project |
|
|
23
|
+
| **Spec** | Feature-level handoff spec for a UI flow | `library/knowledge-base/specs/` | Frontend engineers |
|
|
24
|
+
| **Product Brief** | Product vision, scope, roadmap | `library/knowledge-base/product/` | Team, stakeholders |
|
|
25
|
+
| **Standards Doc** | Rules for writing documentation itself | `library/knowledge-base/standards/` | All contributors |
|
|
26
|
+
| **Release Notes** | What changed in each release | `library/knowledge-base/releases/` | All team members |
|
|
27
|
+
|
|
28
|
+
---
|
|
29
|
+
|
|
30
|
+
## 2. Universal Document Header
|
|
31
|
+
|
|
32
|
+
Every markdown file under `library/knowledge-base/` starts with:
|
|
33
|
+
|
|
34
|
+
```markdown
|
|
35
|
+
# <Document Title>
|
|
36
|
+
|
|
37
|
+
> Category: <Type> | Version: <X.Y> | Date: <Month YYYY> | Status: <Active | Draft | Archived>
|
|
38
|
+
|
|
39
|
+
<One-sentence description of what this document covers and who should read it.>
|
|
40
|
+
|
|
41
|
+
**Related:**
|
|
42
|
+
- [Link to related doc]
|
|
43
|
+
- [Link to source code: `src/path/to/file.ts`]
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
- **Version** — starts at `1.0`; patch bumps (`1.0` → `1.1`) for additions, minor bumps (`1.x` → `2.0`) for reorganizations.
|
|
47
|
+
- **Date** — current month/year on the last meaningful edit.
|
|
48
|
+
- **Status** values:
|
|
49
|
+
- `Active` — current, should be kept up to date
|
|
50
|
+
- `Draft` — work in progress, not authoritative
|
|
51
|
+
- `Archived` — historical, no longer maintained
|
|
52
|
+
- `Canonical` — (for standards docs only) highest authority; overrides ad-hoc conventions
|
|
53
|
+
|
|
54
|
+
Requirements-type docs (issue IRDs, feature PRDs, QA reports) use a different header format documented in their respective guides.
|
|
55
|
+
|
|
56
|
+
---
|
|
57
|
+
|
|
58
|
+
## 3. Filename Conventions
|
|
59
|
+
|
|
60
|
+
| Document type | Folder + filename pattern | Example |
|
|
61
|
+
|---|---|---|
|
|
62
|
+
| Issue IRD | `issue-<###>-<title>/ird-issue-<###>-<title>.md` (with sibling `reports/`) | `issue-046-stale-cached-responses/ird-issue-046-stale-cached-responses.md` |
|
|
63
|
+
| Feature PRD | `feature-<###>-<title>/prd-feature-<###>-<title>.md` (with sibling `reports/`) | `feature-007-user-profile-export/prd-feature-007-user-profile-export.md` |
|
|
64
|
+
| Feature PRD (from ClickUp) | `feature-<###>-<title>/prd-feature-<###>-<title>-ck-<clickupId>.md` | `feature-007-user-profile-export/prd-feature-007-user-profile-export-ck-86c8wq2k1.md` |
|
|
65
|
+
| QA report (tied to plan) | `<plan-folder>/reports/<date>-qa-report.md` | `feature-007-user-profile-export/reports/2026-04-26-qa-report.md` |
|
|
66
|
+
| QA report (standalone) | `library/qa/<domain>/<date>-qa-report.md` | `library/qa/auth/2026-04-26-qa-report.md` |
|
|
67
|
+
| Knowledge-base | `<domain>/<kebab-slug>.md` (no numeric prefix) | `architecture/authentication-flow.md` |
|
|
68
|
+
|
|
69
|
+
**Numbering rules:**
|
|
70
|
+
- `<###>` is **3-digit zero-padded** (`006`, `046`, `093`, `100`). 4+ digit natural width.
|
|
71
|
+
- Issue numbers follow the GitHub issue number.
|
|
72
|
+
- Feature numbers are repo-local sequential; take `max + 1` from existing folders (open + `completed/`).
|
|
73
|
+
- Titles are lowercase kebab-case, ≤60 chars.
|
|
74
|
+
- The optional ClickUp suffix `-ck-<clickupId>` goes on the **main file only**, never on the folder name.
|
|
75
|
+
|
|
76
|
+
---
|
|
77
|
+
|
|
78
|
+
## 4. Folder Location Rules
|
|
79
|
+
|
|
80
|
+
| Folder | Meaning |
|
|
81
|
+
|---|---|
|
|
82
|
+
| `library/requirements/features/feature-<###>-<title>/` | Feature work in progress. |
|
|
83
|
+
| `library/requirements/features/completed/feature-<###>-<title>/` | Feature has shipped. Move the entire folder (PRD + `reports/`). |
|
|
84
|
+
| `library/requirements/issues/issue-<###>-<title>/` | Issue work in progress (GitHub issue OPEN). |
|
|
85
|
+
| `library/requirements/issues/completed/issue-<###>-<title>/` | Issue has been resolved (GitHub issue CLOSED). Move the entire folder (IRD + `reports/`). Symmetric to features. |
|
|
86
|
+
| `<plan-folder>/reports/` | QA reports tied to that specific feature/issue. Travel with the folder when it moves. |
|
|
87
|
+
| `library/qa/<domain>/` | Standalone QA reports — broad audits not tied to a single plan. |
|
|
88
|
+
|
|
89
|
+
Move folders when status changes. Never edit lifecycle state in frontmatter alone.
|
|
90
|
+
|
|
91
|
+
---
|
|
92
|
+
|
|
93
|
+
## 5. Writing Rules (all doc types)
|
|
94
|
+
|
|
95
|
+
1. **Ground every claim in code.** Quote source with file path + line range; never paraphrase signatures.
|
|
96
|
+
2. **One topic per document.** Split if a doc exceeds ~500 lines.
|
|
97
|
+
3. **Progressive disclosure.** Open with "why this exists" and "who should read it"; deep details below.
|
|
98
|
+
4. **Link out, don't duplicate.** If another doc covers a subtopic, link to it.
|
|
99
|
+
5. **Diagrams use mermaid.** Prefer `flowchart TD` or `sequenceDiagram`. No explicit colors.
|
|
100
|
+
6. **No time-sensitive language.** Avoid "currently", "recently", "as of". Use explicit dates.
|
|
101
|
+
7. **No personal opinions.** Docs describe decisions and rationale, not preferences.
|
|
102
|
+
|
|
103
|
+
---
|
|
104
|
+
|
|
105
|
+
## 6. Cross-Linking Conventions
|
|
106
|
+
|
|
107
|
+
- Use relative paths: `[title](../relative/path.md)`.
|
|
108
|
+
- Link to code with file paths (and line numbers where useful): `` `src/routes/users.ts:42-80` ``.
|
|
109
|
+
- PRDs and IRDs link to their related issues, features, and QA reports in a **Related** section at the end.
|
|
110
|
+
- Knowledge-base docs link to the PRDs that drove them (when applicable) and to source code.
|
|
111
|
+
|
|
112
|
+
---
|
|
113
|
+
|
|
114
|
+
## 7. Diagram Rules
|
|
115
|
+
|
|
116
|
+
- Mermaid preferred (renders everywhere GitHub does).
|
|
117
|
+
- Use `flowchart TD` (top-down) for process flows; `sequenceDiagram` for temporal flows; `erDiagram` for data models.
|
|
118
|
+
- Node IDs: no spaces (use `camelCase` or `under_scores`).
|
|
119
|
+
- No explicit colors (breaks dark mode).
|
|
120
|
+
- No `click` events.
|
|
121
|
+
- Quote labels containing parentheses, brackets, or colons.
|
|
122
|
+
|
|
123
|
+
---
|
|
124
|
+
|
|
125
|
+
## 8. Versioning + Dates
|
|
126
|
+
|
|
127
|
+
- **Versioning** is per-document, not repo-wide. Bump on meaningful content change.
|
|
128
|
+
- **Dates** use the current month/year (from the system clock), not arbitrary timestamps.
|
|
129
|
+
- Each document optionally ends with a **Changelog** section listing version bumps.
|
|
130
|
+
|
|
131
|
+
---
|
|
132
|
+
|
|
133
|
+
## 9. Ownership
|
|
134
|
+
|
|
135
|
+
- Requirements docs (issue IRDs, feature PRDs) are owned by the implementation author. QA reports are owned by `quality-guardian`.
|
|
136
|
+
- Knowledge-base docs are owned by the team collectively — anyone may edit with a PR.
|
|
137
|
+
- Standards docs (this file included) require team consensus before changing.
|
|
138
|
+
|
|
139
|
+
---
|
|
140
|
+
|
|
141
|
+
## 10. Bootstrap — After `initialize`
|
|
142
|
+
|
|
143
|
+
When `library-guardian initialize` seeds a repo:
|
|
144
|
+
|
|
145
|
+
1. Replace the placeholder "(fill in on init)" in the header above with the current month/year.
|
|
146
|
+
2. Replace any project-name placeholders in the seeded README files with your repo's actual name.
|
|
147
|
+
3. Edit any section of this framework that doesn't match your team's conventions — then commit.
|
|
148
|
+
4. Start using the agent: ingest issues, plan features, document architecture.
|
|
149
|
+
|
|
150
|
+
---
|
|
151
|
+
|
|
152
|
+
## Changelog
|
|
153
|
+
|
|
154
|
+
- v1.0 — Initial template seeded by `library-guardian`. Customize per repo.
|
|
@@ -1,49 +1,49 @@
|
|
|
1
|
-
---
|
|
2
|
-
ai_description: |
|
|
3
|
-
This folder contains customer-facing / end-user documentation.
|
|
4
|
-
Approved sub-folders: overview/, guides/, faqs/, and any domain
|
|
5
|
-
folder explicitly designated public by the team.
|
|
6
|
-
Do NOT file internal engineering docs, ADRs, pricing strategy, or
|
|
7
|
-
security-sensitive material here.
|
|
8
|
-
Write path: library/knowledge/public/<domain>/<kebab-slug>.md.
|
|
9
|
-
All files here may eventually be surfaced in the public help center
|
|
10
|
-
(Phase 2). Mark each doc with the standard knowledge-base header:
|
|
11
|
-
Category / Version / Date / Status.
|
|
12
|
-
human_description: |
|
|
13
|
-
Customer-facing documentation. Content here may be published externally.
|
|
14
|
-
- overview/: what this product is, glossary, elevator pitch
|
|
15
|
-
- guides/: how-to guides written for users, not developers
|
|
16
|
-
- faqs/: frequently asked questions
|
|
17
|
-
Only add content here that you are comfortable sharing publicly.
|
|
18
|
-
Internal notes, pricing strategy, and architecture docs belong in
|
|
19
|
-
knowledge/private/ instead.
|
|
20
|
-
---
|
|
21
|
-
|
|
22
|
-
# Knowledge — Public
|
|
23
|
-
|
|
24
|
-
Customer-facing documentation for **rflectr** by [Legion Code Inc.](https://github.com/legioncodeinc) Anything in this folder may eventually be published to the help center.
|
|
25
|
-
|
|
26
|
-
## Documentation map
|
|
27
|
-
|
|
28
|
-
**Start here:** [What is rflectr?](overview/what-is-rflectr.md)
|
|
29
|
-
|
|
30
|
-
| Section | Docs |
|
|
31
|
-
|---|---|
|
|
32
|
-
| [Overview](overview/) | [What is rflectr?](overview/what-is-rflectr.md) |
|
|
33
|
-
| [Guides](guides/) | [Providers](guides/providers.md) · [Claude Desktop](guides/claude-desktop.md) · [Codex](guides/codex.md) · [Gemini CLI](guides/gemini-cli.md) · [API Server](guides/api-server.md) · [AI Agents](guides/ai-agents.md) · [Model Compatibility](guides/model-compatibility.md) |
|
|
34
|
-
| [FAQs](faqs/) | [Troubleshooting](faqs/troubleshooting.md) |
|
|
35
|
-
|
|
36
|
-
## Approved sub-folders
|
|
37
|
-
|
|
38
|
-
| Folder | Contents |
|
|
39
|
-
|---|---|
|
|
40
|
-
| `overview/` | What this product is, glossary, elevator pitch, high-level FAQs |
|
|
41
|
-
| `guides/` | Step-by-step user guides (written for customers, not developers) |
|
|
42
|
-
| `faqs/` | Frequently asked questions from customers |
|
|
43
|
-
|
|
44
|
-
## What does NOT belong here
|
|
45
|
-
|
|
46
|
-
- Internal architecture docs or ADRs
|
|
47
|
-
- Pricing strategy or competitive analysis
|
|
48
|
-
- Engineering standards
|
|
49
|
-
- Anything you would not want a customer to read
|
|
1
|
+
---
|
|
2
|
+
ai_description: |
|
|
3
|
+
This folder contains customer-facing / end-user documentation.
|
|
4
|
+
Approved sub-folders: overview/, guides/, faqs/, and any domain
|
|
5
|
+
folder explicitly designated public by the team.
|
|
6
|
+
Do NOT file internal engineering docs, ADRs, pricing strategy, or
|
|
7
|
+
security-sensitive material here.
|
|
8
|
+
Write path: library/knowledge/public/<domain>/<kebab-slug>.md.
|
|
9
|
+
All files here may eventually be surfaced in the public help center
|
|
10
|
+
(Phase 2). Mark each doc with the standard knowledge-base header:
|
|
11
|
+
Category / Version / Date / Status.
|
|
12
|
+
human_description: |
|
|
13
|
+
Customer-facing documentation. Content here may be published externally.
|
|
14
|
+
- overview/: what this product is, glossary, elevator pitch
|
|
15
|
+
- guides/: how-to guides written for users, not developers
|
|
16
|
+
- faqs/: frequently asked questions
|
|
17
|
+
Only add content here that you are comfortable sharing publicly.
|
|
18
|
+
Internal notes, pricing strategy, and architecture docs belong in
|
|
19
|
+
knowledge/private/ instead.
|
|
20
|
+
---
|
|
21
|
+
|
|
22
|
+
# Knowledge — Public
|
|
23
|
+
|
|
24
|
+
Customer-facing documentation for **rflectr** by [Legion Code Inc.](https://github.com/legioncodeinc) Anything in this folder may eventually be published to the help center.
|
|
25
|
+
|
|
26
|
+
## Documentation map
|
|
27
|
+
|
|
28
|
+
**Start here:** [What is rflectr?](overview/what-is-rflectr.md)
|
|
29
|
+
|
|
30
|
+
| Section | Docs |
|
|
31
|
+
|---|---|
|
|
32
|
+
| [Overview](overview/) | [What is rflectr?](overview/what-is-rflectr.md) |
|
|
33
|
+
| [Guides](guides/) | [Providers](guides/providers.md) · [Claude Desktop](guides/claude-desktop.md) · [Codex](guides/codex.md) · [Gemini CLI](guides/gemini-cli.md) · [API Server](guides/api-server.md) · [AI Agents](guides/ai-agents.md) · [Model Compatibility](guides/model-compatibility.md) |
|
|
34
|
+
| [FAQs](faqs/) | [Troubleshooting](faqs/troubleshooting.md) |
|
|
35
|
+
|
|
36
|
+
## Approved sub-folders
|
|
37
|
+
|
|
38
|
+
| Folder | Contents |
|
|
39
|
+
|---|---|
|
|
40
|
+
| `overview/` | What this product is, glossary, elevator pitch, high-level FAQs |
|
|
41
|
+
| `guides/` | Step-by-step user guides (written for customers, not developers) |
|
|
42
|
+
| `faqs/` | Frequently asked questions from customers |
|
|
43
|
+
|
|
44
|
+
## What does NOT belong here
|
|
45
|
+
|
|
46
|
+
- Internal architecture docs or ADRs
|
|
47
|
+
- Pricing strategy or competitive analysis
|
|
48
|
+
- Engineering standards
|
|
49
|
+
- Anything you would not want a customer to read
|
package/library/notes/README.md
CHANGED
|
@@ -1,21 +1,21 @@
|
|
|
1
|
-
---
|
|
2
|
-
ai_description: |
|
|
3
|
-
HUMAN-ONLY junk drawer. Agents MUST NOT read from, write to, create
|
|
4
|
-
files in, or reference files in this folder for any purpose.
|
|
5
|
-
If you want to capture something persistent, write to
|
|
6
|
-
library/knowledge/private/<domain>/<slug>.md instead.
|
|
7
|
-
This invariant is absolute and has no exceptions.
|
|
8
|
-
human_description: |
|
|
9
|
-
Unstructured scratch space for humans. Agents do not touch this folder.
|
|
10
|
-
Put anything here: rough notes, links, half-formed ideas, meeting notes.
|
|
11
|
-
Nothing in notes/ is authoritative or maintained.
|
|
12
|
-
For persistent reference, move content to knowledge/private/ when it matures.
|
|
13
|
-
---
|
|
14
|
-
|
|
15
|
-
# Notes
|
|
16
|
-
|
|
17
|
-
Human-only scratch space. Agents never read or write here.
|
|
18
|
-
|
|
19
|
-
Put rough notes, links, and half-formed ideas here. Nothing here is authoritative.
|
|
20
|
-
|
|
21
|
-
When a note matures into reference material, move it to `knowledge/private/<domain>/`.
|
|
1
|
+
---
|
|
2
|
+
ai_description: |
|
|
3
|
+
HUMAN-ONLY junk drawer. Agents MUST NOT read from, write to, create
|
|
4
|
+
files in, or reference files in this folder for any purpose.
|
|
5
|
+
If you want to capture something persistent, write to
|
|
6
|
+
library/knowledge/private/<domain>/<slug>.md instead.
|
|
7
|
+
This invariant is absolute and has no exceptions.
|
|
8
|
+
human_description: |
|
|
9
|
+
Unstructured scratch space for humans. Agents do not touch this folder.
|
|
10
|
+
Put anything here: rough notes, links, half-formed ideas, meeting notes.
|
|
11
|
+
Nothing in notes/ is authoritative or maintained.
|
|
12
|
+
For persistent reference, move content to knowledge/private/ when it matures.
|
|
13
|
+
---
|
|
14
|
+
|
|
15
|
+
# Notes
|
|
16
|
+
|
|
17
|
+
Human-only scratch space. Agents never read or write here.
|
|
18
|
+
|
|
19
|
+
Put rough notes, links, and half-formed ideas here. Nothing here is authoritative.
|
|
20
|
+
|
|
21
|
+
When a note matures into reference material, move it to `knowledge/private/<domain>/`.
|
|
@@ -1,51 +1,51 @@
|
|
|
1
|
-
---
|
|
2
|
-
ai_description: |
|
|
3
|
-
This folder contains all planned product and feature work (PRDs).
|
|
4
|
-
Sub-folders: backlog/ (queued, not started), in-work/ (actively
|
|
5
|
-
being implemented), completed/ (shipped), reports/ (routine code scans).
|
|
6
|
-
Lifecycle = location: move entire PRD folders between states.
|
|
7
|
-
PRD folder naming: prd-<###>-<kebab-slug>/
|
|
8
|
-
PRD numbers are repo-local sequential. Take max+1 from all prd-* folders
|
|
9
|
-
across backlog/, in-work/, and completed/.
|
|
10
|
-
Never write PRD content outside of a prd-<###>-<slug>/ folder.
|
|
11
|
-
Do NOT put IRDs here — those go in issues/ (peer of requirements/).
|
|
12
|
-
human_description: |
|
|
13
|
-
Product and feature work (PRDs) organized by lifecycle stage.
|
|
14
|
-
- backlog/: planned work not yet started
|
|
15
|
-
- in-work/: currently being implemented
|
|
16
|
-
- completed/: shipped work (move entire folder here when done)
|
|
17
|
-
- reports/: routine code-scan and QA reports not tied to a specific PRD
|
|
18
|
-
To start a new PRD: create prd-<###>-<slug>/ in backlog/ with an index.md.
|
|
19
|
-
To move lifecycle: move the entire prd-<###>-<slug>/ folder.
|
|
20
|
-
---
|
|
21
|
-
|
|
22
|
-
# Requirements
|
|
23
|
-
|
|
24
|
-
Product and feature work, organized by lifecycle state.
|
|
25
|
-
|
|
26
|
-
## Sub-folders
|
|
27
|
-
|
|
28
|
-
| Folder | State | Description |
|
|
29
|
-
|---|---|---|
|
|
30
|
-
| `backlog/` | Queued | PRDs planned but not yet started |
|
|
31
|
-
| `in-work/` | Active | PRDs currently being implemented |
|
|
32
|
-
| `completed/` | Shipped | Entire PRD folder moves here when work ships |
|
|
33
|
-
| `reports/` | Evergreen | Routine code-scan and QA reports not tied to a PRD |
|
|
34
|
-
|
|
35
|
-
## PRD folder structure
|
|
36
|
-
|
|
37
|
-
```
|
|
38
|
-
prd-007-user-export/
|
|
39
|
-
prd-007-user-export-index.md module overview + feature list
|
|
40
|
-
prd-007a-user-export-backend.md sub-feature a
|
|
41
|
-
prd-007b-user-export-ui.md sub-feature b
|
|
42
|
-
qa/
|
|
43
|
-
prd-007-user-export-qa.md QA audit (written by quality-guardian)
|
|
44
|
-
```
|
|
45
|
-
|
|
46
|
-
## Naming
|
|
47
|
-
|
|
48
|
-
- Folder: `prd-<###>-<kebab-slug>/` (3-digit zero-padded)
|
|
49
|
-
- Index: `prd-<###>-<kebab-slug>-index.md`
|
|
50
|
-
- Sub-PRDs: `prd-<###><letter>-<kebab-slug>-<feature>.md`
|
|
51
|
-
- PRD numbers are **repo-local sequential** — not GitHub issue numbers.
|
|
1
|
+
---
|
|
2
|
+
ai_description: |
|
|
3
|
+
This folder contains all planned product and feature work (PRDs).
|
|
4
|
+
Sub-folders: backlog/ (queued, not started), in-work/ (actively
|
|
5
|
+
being implemented), completed/ (shipped), reports/ (routine code scans).
|
|
6
|
+
Lifecycle = location: move entire PRD folders between states.
|
|
7
|
+
PRD folder naming: prd-<###>-<kebab-slug>/
|
|
8
|
+
PRD numbers are repo-local sequential. Take max+1 from all prd-* folders
|
|
9
|
+
across backlog/, in-work/, and completed/.
|
|
10
|
+
Never write PRD content outside of a prd-<###>-<slug>/ folder.
|
|
11
|
+
Do NOT put IRDs here — those go in issues/ (peer of requirements/).
|
|
12
|
+
human_description: |
|
|
13
|
+
Product and feature work (PRDs) organized by lifecycle stage.
|
|
14
|
+
- backlog/: planned work not yet started
|
|
15
|
+
- in-work/: currently being implemented
|
|
16
|
+
- completed/: shipped work (move entire folder here when done)
|
|
17
|
+
- reports/: routine code-scan and QA reports not tied to a specific PRD
|
|
18
|
+
To start a new PRD: create prd-<###>-<slug>/ in backlog/ with an index.md.
|
|
19
|
+
To move lifecycle: move the entire prd-<###>-<slug>/ folder.
|
|
20
|
+
---
|
|
21
|
+
|
|
22
|
+
# Requirements
|
|
23
|
+
|
|
24
|
+
Product and feature work, organized by lifecycle state.
|
|
25
|
+
|
|
26
|
+
## Sub-folders
|
|
27
|
+
|
|
28
|
+
| Folder | State | Description |
|
|
29
|
+
|---|---|---|
|
|
30
|
+
| `backlog/` | Queued | PRDs planned but not yet started |
|
|
31
|
+
| `in-work/` | Active | PRDs currently being implemented |
|
|
32
|
+
| `completed/` | Shipped | Entire PRD folder moves here when work ships |
|
|
33
|
+
| `reports/` | Evergreen | Routine code-scan and QA reports not tied to a PRD |
|
|
34
|
+
|
|
35
|
+
## PRD folder structure
|
|
36
|
+
|
|
37
|
+
```
|
|
38
|
+
prd-007-user-export/
|
|
39
|
+
prd-007-user-export-index.md module overview + feature list
|
|
40
|
+
prd-007a-user-export-backend.md sub-feature a
|
|
41
|
+
prd-007b-user-export-ui.md sub-feature b
|
|
42
|
+
qa/
|
|
43
|
+
prd-007-user-export-qa.md QA audit (written by quality-guardian)
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
## Naming
|
|
47
|
+
|
|
48
|
+
- Folder: `prd-<###>-<kebab-slug>/` (3-digit zero-padded)
|
|
49
|
+
- Index: `prd-<###>-<kebab-slug>-index.md`
|
|
50
|
+
- Sub-PRDs: `prd-<###><letter>-<kebab-slug>-<feature>.md`
|
|
51
|
+
- PRD numbers are **repo-local sequential** — not GitHub issue numbers.
|
|
@@ -1,30 +1,30 @@
|
|
|
1
|
-
---
|
|
2
|
-
ai_description: |
|
|
3
|
-
Contains PRD folders planned but not yet started. This is where
|
|
4
|
-
library-guardian creates new PRD folders on "write a PRD for X".
|
|
5
|
-
PRD folder naming: prd-<###>-<kebab-slug>/ (3-digit zero-padded).
|
|
6
|
-
PRD number: take max+1 from all prd-* folders across backlog/,
|
|
7
|
-
in-work/, and completed/ in this repo.
|
|
8
|
-
Each PRD folder must contain: prd-<###>-<slug>-index.md (always),
|
|
9
|
-
prd-<###><letter>-<slug>-<feature>.md (one per sub-feature, optional),
|
|
10
|
-
qa/ subfolder (empty on creation; quality-guardian writes QA reports here).
|
|
11
|
-
Move entire folder to in-work/ when implementation begins.
|
|
12
|
-
human_description: |
|
|
13
|
-
PRDs planned but not yet started. Create new PRDs here.
|
|
14
|
-
- Naming: prd-007-feature-name/ with prd-007-feature-name-index.md inside
|
|
15
|
-
- Sub-features: prd-007a-feature-name-backend.md, prd-007b-feature-name-ui.md
|
|
16
|
-
- QA folder: qa/prd-007-feature-name-qa.md (created by quality-guardian)
|
|
17
|
-
Move to in-work/ when implementation begins.
|
|
18
|
-
---
|
|
19
|
-
|
|
20
|
-
# Requirements — Backlog
|
|
21
|
-
|
|
22
|
-
Planned PRDs not yet in implementation. All new PRD folders are created here.
|
|
23
|
-
|
|
24
|
-
## Creating a new PRD
|
|
25
|
-
|
|
26
|
-
1. Find `max_n` across `backlog/prd-*/`, `in-work/prd-*/`, `completed/prd-*/`.
|
|
27
|
-
2. Create `prd-<max_n + 1>-<kebab-slug>/`.
|
|
28
|
-
3. Create `prd-<###>-<slug>-index.md` (module overview + feature list).
|
|
29
|
-
4. Create `qa/` subfolder (empty; `quality-guardian` writes reports here).
|
|
30
|
-
5. Add sub-PRDs `prd-<###>a-<slug>-<feature>.md` etc. as needed.
|
|
1
|
+
---
|
|
2
|
+
ai_description: |
|
|
3
|
+
Contains PRD folders planned but not yet started. This is where
|
|
4
|
+
library-guardian creates new PRD folders on "write a PRD for X".
|
|
5
|
+
PRD folder naming: prd-<###>-<kebab-slug>/ (3-digit zero-padded).
|
|
6
|
+
PRD number: take max+1 from all prd-* folders across backlog/,
|
|
7
|
+
in-work/, and completed/ in this repo.
|
|
8
|
+
Each PRD folder must contain: prd-<###>-<slug>-index.md (always),
|
|
9
|
+
prd-<###><letter>-<slug>-<feature>.md (one per sub-feature, optional),
|
|
10
|
+
qa/ subfolder (empty on creation; quality-guardian writes QA reports here).
|
|
11
|
+
Move entire folder to in-work/ when implementation begins.
|
|
12
|
+
human_description: |
|
|
13
|
+
PRDs planned but not yet started. Create new PRDs here.
|
|
14
|
+
- Naming: prd-007-feature-name/ with prd-007-feature-name-index.md inside
|
|
15
|
+
- Sub-features: prd-007a-feature-name-backend.md, prd-007b-feature-name-ui.md
|
|
16
|
+
- QA folder: qa/prd-007-feature-name-qa.md (created by quality-guardian)
|
|
17
|
+
Move to in-work/ when implementation begins.
|
|
18
|
+
---
|
|
19
|
+
|
|
20
|
+
# Requirements — Backlog
|
|
21
|
+
|
|
22
|
+
Planned PRDs not yet in implementation. All new PRD folders are created here.
|
|
23
|
+
|
|
24
|
+
## Creating a new PRD
|
|
25
|
+
|
|
26
|
+
1. Find `max_n` across `backlog/prd-*/`, `in-work/prd-*/`, `completed/prd-*/`.
|
|
27
|
+
2. Create `prd-<max_n + 1>-<kebab-slug>/`.
|
|
28
|
+
3. Create `prd-<###>-<slug>-index.md` (module overview + feature list).
|
|
29
|
+
4. Create `qa/` subfolder (empty; `quality-guardian` writes reports here).
|
|
30
|
+
5. Add sub-PRDs `prd-<###>a-<slug>-<feature>.md` etc. as needed.
|