@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
package/README.md
CHANGED
|
@@ -43,11 +43,7 @@ Launch your tools, switch providers mid-session, and run local API gateways &mda
|
|
|
43
43
|
|
|
44
44
|
<br>
|
|
45
45
|
|
|
46
|
-
<
|
|
47
|
-
<source media="(prefers-color-scheme: dark)" srcset="assets/rflectr-overview.png">
|
|
48
|
-
<source media="(prefers-color-scheme: light)" srcset="assets/rflectr-overview.png">
|
|
49
|
-
<img alt="rflectr — relay any model into any coding agent. You pick a coding tool, rflectr launches it and routes requests to any model provider you choose." src="assets/rflectr-overview.png" width="900">
|
|
50
|
-
</picture>
|
|
46
|
+
<img alt="rflectr — relay any model into any coding agent. You pick a coding tool, rflectr launches it and routes requests to any model provider you choose." src="https://github.com/legioncodeinc/rflectr/raw/cdaf2738d5e33e83a2c3b09d4bf604ef8426ca86/assets/733630021_1421561133353555_3999689754075308337_n.jpg" width="900">
|
|
51
47
|
|
|
52
48
|
<br>
|
|
53
49
|
<br>
|
package/dist/cli.js
CHANGED
package/library/README.md
CHANGED
|
@@ -1,39 +1,39 @@
|
|
|
1
|
-
---
|
|
2
|
-
ai_description: |
|
|
3
|
-
This is the root of the repository's documentation library (schema v2).
|
|
4
|
-
You own everything under library/ except notes/, which is human-only.
|
|
5
|
-
Sub-trees: knowledge/ (public and private docs), requirements/ (product
|
|
6
|
-
work: PRDs), issues/ (reactive bug/incident work: IRDs), notes/ (junk
|
|
7
|
-
drawer, read-only to agents).
|
|
8
|
-
Schema reference: legion-shared/standards/library-schema-v2.md.
|
|
9
|
-
Standardize script: pnpm standardize-library --repository <name>.
|
|
10
|
-
human_description: |
|
|
11
|
-
Root of this repository's documentation library.
|
|
12
|
-
- knowledge/: reference documentation split by audience (public vs private)
|
|
13
|
-
- requirements/: planned product work (PRDs) with backlog/in-work/completed lifecycle
|
|
14
|
-
- issues/: reactive bug and incident work (IRDs) with same lifecycle
|
|
15
|
-
- notes/: unstructured scratch space — only humans write here
|
|
16
|
-
Run `pnpm standardize-library --repository <name>` to scaffold any missing structure.
|
|
17
|
-
---
|
|
18
|
-
|
|
19
|
-
# Library
|
|
20
|
-
|
|
21
|
-
Documentation root for this repository. Schema version: **v2**.
|
|
22
|
-
|
|
23
|
-
See [`legion-shared/standards/library-schema-v2.md`](../../legion-shared/standards/library-schema-v2.md) for the full specification.
|
|
24
|
-
|
|
25
|
-
## Top-level layout
|
|
26
|
-
|
|
27
|
-
| Folder | What goes here |
|
|
28
|
-
|---|---|
|
|
29
|
-
| `knowledge/public/` | End-user / customer-facing docs: overviews, guides, FAQs |
|
|
30
|
-
| `knowledge/private/` | Internal engineering and business docs: ADRs, standards, domain knowledge |
|
|
31
|
-
| `requirements/` | Product and feature work: PRDs in backlog/in-work/completed |
|
|
32
|
-
| `issues/` | Reactive bug and incident work: IRDs in backlog/in-work/completed |
|
|
33
|
-
| `notes/` | Human-only scratch space |
|
|
34
|
-
|
|
35
|
-
## What does NOT belong here
|
|
36
|
-
|
|
37
|
-
- Brand assets → `legion-shared/brands/`
|
|
38
|
-
- Wiki entity pages → `legion-wiki/<repo>/wiki/` (derived, never edit)
|
|
39
|
-
- Library mirrors → `legion-wiki/<repo>/library/` (derived, never edit)
|
|
1
|
+
---
|
|
2
|
+
ai_description: |
|
|
3
|
+
This is the root of the repository's documentation library (schema v2).
|
|
4
|
+
You own everything under library/ except notes/, which is human-only.
|
|
5
|
+
Sub-trees: knowledge/ (public and private docs), requirements/ (product
|
|
6
|
+
work: PRDs), issues/ (reactive bug/incident work: IRDs), notes/ (junk
|
|
7
|
+
drawer, read-only to agents).
|
|
8
|
+
Schema reference: legion-shared/standards/library-schema-v2.md.
|
|
9
|
+
Standardize script: pnpm standardize-library --repository <name>.
|
|
10
|
+
human_description: |
|
|
11
|
+
Root of this repository's documentation library.
|
|
12
|
+
- knowledge/: reference documentation split by audience (public vs private)
|
|
13
|
+
- requirements/: planned product work (PRDs) with backlog/in-work/completed lifecycle
|
|
14
|
+
- issues/: reactive bug and incident work (IRDs) with same lifecycle
|
|
15
|
+
- notes/: unstructured scratch space — only humans write here
|
|
16
|
+
Run `pnpm standardize-library --repository <name>` to scaffold any missing structure.
|
|
17
|
+
---
|
|
18
|
+
|
|
19
|
+
# Library
|
|
20
|
+
|
|
21
|
+
Documentation root for this repository. Schema version: **v2**.
|
|
22
|
+
|
|
23
|
+
See [`legion-shared/standards/library-schema-v2.md`](../../legion-shared/standards/library-schema-v2.md) for the full specification.
|
|
24
|
+
|
|
25
|
+
## Top-level layout
|
|
26
|
+
|
|
27
|
+
| Folder | What goes here |
|
|
28
|
+
|---|---|
|
|
29
|
+
| `knowledge/public/` | End-user / customer-facing docs: overviews, guides, FAQs |
|
|
30
|
+
| `knowledge/private/` | Internal engineering and business docs: ADRs, standards, domain knowledge |
|
|
31
|
+
| `requirements/` | Product and feature work: PRDs in backlog/in-work/completed |
|
|
32
|
+
| `issues/` | Reactive bug and incident work: IRDs in backlog/in-work/completed |
|
|
33
|
+
| `notes/` | Human-only scratch space |
|
|
34
|
+
|
|
35
|
+
## What does NOT belong here
|
|
36
|
+
|
|
37
|
+
- Brand assets → `legion-shared/brands/`
|
|
38
|
+
- Wiki entity pages → `legion-wiki/<repo>/wiki/` (derived, never edit)
|
|
39
|
+
- Library mirrors → `legion-wiki/<repo>/library/` (derived, never edit)
|
package/library/issues/README.md
CHANGED
|
@@ -1,46 +1,46 @@
|
|
|
1
|
-
---
|
|
2
|
-
ai_description: |
|
|
3
|
-
This folder contains all reactive bug and incident work (IRDs).
|
|
4
|
-
It is a PEER of requirements/, not nested under it.
|
|
5
|
-
Sub-folders: backlog/, in-work/, completed/ — same lifecycle as requirements/.
|
|
6
|
-
IRD folder naming: ird-<###>-<kebab-slug>/
|
|
7
|
-
IRD numbers match the GitHub issue number for this repo.
|
|
8
|
-
Never invent IRD numbers — a GitHub issue must exist first.
|
|
9
|
-
IRDs are single-scope: one issue per IRD, no sub-IRDs.
|
|
10
|
-
Do NOT put PRDs here — those go in requirements/.
|
|
11
|
-
human_description: |
|
|
12
|
-
Reactive bug and incident work (IRDs), organized by lifecycle stage.
|
|
13
|
-
- backlog/: tracked issues with a fix plan, not yet started
|
|
14
|
-
- in-work/: issues currently being fixed
|
|
15
|
-
- completed/: resolved issues (move entire folder)
|
|
16
|
-
IRD numbers match GitHub issue numbers. Create an IRD only after the
|
|
17
|
-
GitHub issue exists.
|
|
18
|
-
---
|
|
19
|
-
|
|
20
|
-
# Issues
|
|
21
|
-
|
|
22
|
-
Reactive bug and incident work (IRDs), organized by lifecycle state.
|
|
23
|
-
|
|
24
|
-
## Sub-folders
|
|
25
|
-
|
|
26
|
-
| Folder | State | Description |
|
|
27
|
-
|---|---|---|
|
|
28
|
-
| `backlog/` | Tracked | IRDs with a fix plan, not yet in progress |
|
|
29
|
-
| `in-work/` | Active | Issues currently being resolved |
|
|
30
|
-
| `completed/` | Resolved | Entire IRD folder moves here when the issue closes |
|
|
31
|
-
|
|
32
|
-
## IRD folder structure
|
|
33
|
-
|
|
34
|
-
```
|
|
35
|
-
ird-042-stale-cache/
|
|
36
|
-
ird-042-stale-cache-index.md single-scope fix plan
|
|
37
|
-
qa/
|
|
38
|
-
ird-042-stale-cache-qa.md QA audit (written by quality-guardian)
|
|
39
|
-
```
|
|
40
|
-
|
|
41
|
-
## Naming rules
|
|
42
|
-
|
|
43
|
-
- Folder: `ird-<###>-<kebab-slug>/`
|
|
44
|
-
- Index: `ird-<###>-<kebab-slug>-index.md`
|
|
45
|
-
- IRD number = GitHub issue number (never invented)
|
|
46
|
-
- No sub-IRDs (scope one issue per IRD)
|
|
1
|
+
---
|
|
2
|
+
ai_description: |
|
|
3
|
+
This folder contains all reactive bug and incident work (IRDs).
|
|
4
|
+
It is a PEER of requirements/, not nested under it.
|
|
5
|
+
Sub-folders: backlog/, in-work/, completed/ — same lifecycle as requirements/.
|
|
6
|
+
IRD folder naming: ird-<###>-<kebab-slug>/
|
|
7
|
+
IRD numbers match the GitHub issue number for this repo.
|
|
8
|
+
Never invent IRD numbers — a GitHub issue must exist first.
|
|
9
|
+
IRDs are single-scope: one issue per IRD, no sub-IRDs.
|
|
10
|
+
Do NOT put PRDs here — those go in requirements/.
|
|
11
|
+
human_description: |
|
|
12
|
+
Reactive bug and incident work (IRDs), organized by lifecycle stage.
|
|
13
|
+
- backlog/: tracked issues with a fix plan, not yet started
|
|
14
|
+
- in-work/: issues currently being fixed
|
|
15
|
+
- completed/: resolved issues (move entire folder)
|
|
16
|
+
IRD numbers match GitHub issue numbers. Create an IRD only after the
|
|
17
|
+
GitHub issue exists.
|
|
18
|
+
---
|
|
19
|
+
|
|
20
|
+
# Issues
|
|
21
|
+
|
|
22
|
+
Reactive bug and incident work (IRDs), organized by lifecycle state.
|
|
23
|
+
|
|
24
|
+
## Sub-folders
|
|
25
|
+
|
|
26
|
+
| Folder | State | Description |
|
|
27
|
+
|---|---|---|
|
|
28
|
+
| `backlog/` | Tracked | IRDs with a fix plan, not yet in progress |
|
|
29
|
+
| `in-work/` | Active | Issues currently being resolved |
|
|
30
|
+
| `completed/` | Resolved | Entire IRD folder moves here when the issue closes |
|
|
31
|
+
|
|
32
|
+
## IRD folder structure
|
|
33
|
+
|
|
34
|
+
```
|
|
35
|
+
ird-042-stale-cache/
|
|
36
|
+
ird-042-stale-cache-index.md single-scope fix plan
|
|
37
|
+
qa/
|
|
38
|
+
ird-042-stale-cache-qa.md QA audit (written by quality-guardian)
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
## Naming rules
|
|
42
|
+
|
|
43
|
+
- Folder: `ird-<###>-<kebab-slug>/`
|
|
44
|
+
- Index: `ird-<###>-<kebab-slug>-index.md`
|
|
45
|
+
- IRD number = GitHub issue number (never invented)
|
|
46
|
+
- No sub-IRDs (scope one issue per IRD)
|
|
@@ -1,26 +1,26 @@
|
|
|
1
|
-
---
|
|
2
|
-
ai_description: |
|
|
3
|
-
Contains IRD folders for tracked issues not yet in active fix work.
|
|
4
|
-
Create a new IRD here only AFTER the GitHub issue exists for this repo.
|
|
5
|
-
IRD folder: ird-<###>-<slug>/ where ### = GitHub issue number.
|
|
6
|
-
Must contain: ird-<###>-<slug>-index.md (the fix plan) and qa/ folder.
|
|
7
|
-
IRDs are single-scope: do not add sub-IRDs.
|
|
8
|
-
human_description: |
|
|
9
|
-
IRDs planned but not yet in active fix work. Create IRDs here.
|
|
10
|
-
- Naming: ird-042-stale-cache/ with ird-042-stale-cache-index.md inside
|
|
11
|
-
- IRD number must match the GitHub issue number
|
|
12
|
-
- Create only after the GitHub issue exists
|
|
13
|
-
Move to in-work/ when fix work begins.
|
|
14
|
-
---
|
|
15
|
-
|
|
16
|
-
# Issues — Backlog
|
|
17
|
-
|
|
18
|
-
Tracked issues with a fix plan, not yet in active resolution.
|
|
19
|
-
|
|
20
|
-
## Creating a new IRD
|
|
21
|
-
|
|
22
|
-
1. Confirm the GitHub issue number (e.g., #42).
|
|
23
|
-
2. Create `ird-042-<kebab-slug>/`.
|
|
24
|
-
3. Create `ird-042-<slug>-index.md` — the single-scope fix plan.
|
|
25
|
-
4. Create `qa/` subfolder (empty; `quality-guardian` writes here).
|
|
26
|
-
5. No sub-IRDs — keep scope to one issue.
|
|
1
|
+
---
|
|
2
|
+
ai_description: |
|
|
3
|
+
Contains IRD folders for tracked issues not yet in active fix work.
|
|
4
|
+
Create a new IRD here only AFTER the GitHub issue exists for this repo.
|
|
5
|
+
IRD folder: ird-<###>-<slug>/ where ### = GitHub issue number.
|
|
6
|
+
Must contain: ird-<###>-<slug>-index.md (the fix plan) and qa/ folder.
|
|
7
|
+
IRDs are single-scope: do not add sub-IRDs.
|
|
8
|
+
human_description: |
|
|
9
|
+
IRDs planned but not yet in active fix work. Create IRDs here.
|
|
10
|
+
- Naming: ird-042-stale-cache/ with ird-042-stale-cache-index.md inside
|
|
11
|
+
- IRD number must match the GitHub issue number
|
|
12
|
+
- Create only after the GitHub issue exists
|
|
13
|
+
Move to in-work/ when fix work begins.
|
|
14
|
+
---
|
|
15
|
+
|
|
16
|
+
# Issues — Backlog
|
|
17
|
+
|
|
18
|
+
Tracked issues with a fix plan, not yet in active resolution.
|
|
19
|
+
|
|
20
|
+
## Creating a new IRD
|
|
21
|
+
|
|
22
|
+
1. Confirm the GitHub issue number (e.g., #42).
|
|
23
|
+
2. Create `ird-042-<kebab-slug>/`.
|
|
24
|
+
3. Create `ird-042-<slug>-index.md` — the single-scope fix plan.
|
|
25
|
+
4. Create `qa/` subfolder (empty; `quality-guardian` writes here).
|
|
26
|
+
5. No sub-IRDs — keep scope to one issue.
|
|
@@ -1,13 +1,13 @@
|
|
|
1
|
-
---
|
|
2
|
-
ai_description: |
|
|
3
|
-
Resolved IRD folders. Entire ird-<###>-<slug>/ folders move here from
|
|
4
|
-
in-work/ when the corresponding GitHub issue is closed and verified.
|
|
5
|
-
Read-only after landing — do NOT edit or re-open IRDs here.
|
|
6
|
-
human_description: |
|
|
7
|
-
Resolved issue folders. Move entire ird-NNN-slug/ here from in-work/
|
|
8
|
-
when the GitHub issue is closed and the fix is confirmed. Read-only.
|
|
9
|
-
---
|
|
10
|
-
|
|
11
|
-
# Issues — Completed
|
|
12
|
-
|
|
13
|
-
Resolved IRD folders. Entire `ird-<###>-<slug>/` folders land here when the GitHub issue closes and the fix is confirmed. Do not edit files here after landing.
|
|
1
|
+
---
|
|
2
|
+
ai_description: |
|
|
3
|
+
Resolved IRD folders. Entire ird-<###>-<slug>/ folders move here from
|
|
4
|
+
in-work/ when the corresponding GitHub issue is closed and verified.
|
|
5
|
+
Read-only after landing — do NOT edit or re-open IRDs here.
|
|
6
|
+
human_description: |
|
|
7
|
+
Resolved issue folders. Move entire ird-NNN-slug/ here from in-work/
|
|
8
|
+
when the GitHub issue is closed and the fix is confirmed. Read-only.
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
# Issues — Completed
|
|
12
|
+
|
|
13
|
+
Resolved IRD folders. Entire `ird-<###>-<slug>/` folders land here when the GitHub issue closes and the fix is confirmed. Do not edit files here after landing.
|
|
@@ -1,13 +1,13 @@
|
|
|
1
|
-
---
|
|
2
|
-
ai_description: |
|
|
3
|
-
IRD folders actively being resolved. Mirror of requirements/in-work/
|
|
4
|
-
but for issues. Move entire ird-<###>-<slug>/ folder from backlog/
|
|
5
|
-
here when fix work begins, then to completed/ when the issue closes.
|
|
6
|
-
human_description: |
|
|
7
|
-
IRDs currently being fixed. Move folder from backlog/ here when work
|
|
8
|
-
starts, and to completed/ when the GitHub issue is closed.
|
|
9
|
-
---
|
|
10
|
-
|
|
11
|
-
# Issues — In Work
|
|
12
|
-
|
|
13
|
-
IRDs currently being resolved. Move from `backlog/` → here when fix work starts, then `completed/` when the GitHub issue closes.
|
|
1
|
+
---
|
|
2
|
+
ai_description: |
|
|
3
|
+
IRD folders actively being resolved. Mirror of requirements/in-work/
|
|
4
|
+
but for issues. Move entire ird-<###>-<slug>/ folder from backlog/
|
|
5
|
+
here when fix work begins, then to completed/ when the issue closes.
|
|
6
|
+
human_description: |
|
|
7
|
+
IRDs currently being fixed. Move folder from backlog/ here when work
|
|
8
|
+
starts, and to completed/ when the GitHub issue is closed.
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
# Issues — In Work
|
|
12
|
+
|
|
13
|
+
IRDs currently being resolved. Move from `backlog/` → here when fix work starts, then `completed/` when the GitHub issue closes.
|
|
@@ -1,34 +1,34 @@
|
|
|
1
|
-
---
|
|
2
|
-
ai_description: |
|
|
3
|
-
This folder contains all reference documentation for this repository,
|
|
4
|
-
split by intended audience: public/ for end-users, private/ for internal
|
|
5
|
-
team and AI agents. When filing a new doc, default to private/. Promote
|
|
6
|
-
to public/ only when the content is intentionally customer-facing.
|
|
7
|
-
Allowed writes: knowledge/public/<domain>/<slug>.md and
|
|
8
|
-
knowledge/private/<domain>/<slug>.md. ADRs always go in
|
|
9
|
-
knowledge/private/architecture/ADR-<n>-<slug>.md.
|
|
10
|
-
Never write to knowledge/ itself (write to the sub-folders).
|
|
11
|
-
human_description: |
|
|
12
|
-
Reference documentation split by audience.
|
|
13
|
-
- public/: docs that will eventually be surfaced to customers or published
|
|
14
|
-
- private/: internal engineering, architecture, business, and strategy docs
|
|
15
|
-
When adding a new doc, pick the right subdomain folder inside public/ or
|
|
16
|
-
private/. If the domain doesn't exist yet, create it.
|
|
17
|
-
---
|
|
18
|
-
|
|
19
|
-
# Knowledge
|
|
20
|
-
|
|
21
|
-
Reference documentation for this repository, organized by audience.
|
|
22
|
-
|
|
23
|
-
## Sub-folders
|
|
24
|
-
|
|
25
|
-
| Folder | Audience | Typical content |
|
|
26
|
-
|---|---|---|
|
|
27
|
-
| `public/` | End-users, customers, external | Overviews, user guides, FAQs |
|
|
28
|
-
| `private/` | Internal team + AI agents | ADRs, standards, architecture, domain engineering docs |
|
|
29
|
-
|
|
30
|
-
## Decision rule: public vs private
|
|
31
|
-
|
|
32
|
-
> "Would I publish this on a help center or product docs site?"
|
|
33
|
-
|
|
34
|
-
Yes → `public/`. No → `private/`. When in doubt, `private/`.
|
|
1
|
+
---
|
|
2
|
+
ai_description: |
|
|
3
|
+
This folder contains all reference documentation for this repository,
|
|
4
|
+
split by intended audience: public/ for end-users, private/ for internal
|
|
5
|
+
team and AI agents. When filing a new doc, default to private/. Promote
|
|
6
|
+
to public/ only when the content is intentionally customer-facing.
|
|
7
|
+
Allowed writes: knowledge/public/<domain>/<slug>.md and
|
|
8
|
+
knowledge/private/<domain>/<slug>.md. ADRs always go in
|
|
9
|
+
knowledge/private/architecture/ADR-<n>-<slug>.md.
|
|
10
|
+
Never write to knowledge/ itself (write to the sub-folders).
|
|
11
|
+
human_description: |
|
|
12
|
+
Reference documentation split by audience.
|
|
13
|
+
- public/: docs that will eventually be surfaced to customers or published
|
|
14
|
+
- private/: internal engineering, architecture, business, and strategy docs
|
|
15
|
+
When adding a new doc, pick the right subdomain folder inside public/ or
|
|
16
|
+
private/. If the domain doesn't exist yet, create it.
|
|
17
|
+
---
|
|
18
|
+
|
|
19
|
+
# Knowledge
|
|
20
|
+
|
|
21
|
+
Reference documentation for this repository, organized by audience.
|
|
22
|
+
|
|
23
|
+
## Sub-folders
|
|
24
|
+
|
|
25
|
+
| Folder | Audience | Typical content |
|
|
26
|
+
|---|---|---|
|
|
27
|
+
| `public/` | End-users, customers, external | Overviews, user guides, FAQs |
|
|
28
|
+
| `private/` | Internal team + AI agents | ADRs, standards, architecture, domain engineering docs |
|
|
29
|
+
|
|
30
|
+
## Decision rule: public vs private
|
|
31
|
+
|
|
32
|
+
> "Would I publish this on a help center or product docs site?"
|
|
33
|
+
|
|
34
|
+
Yes → `public/`. No → `private/`. When in doubt, `private/`.
|
|
@@ -1,40 +1,40 @@
|
|
|
1
|
-
---
|
|
2
|
-
ai_description: |
|
|
3
|
-
This folder contains internal engineering and business documentation.
|
|
4
|
-
ADRs MUST live in architecture/ADR-<n>-<kebab-slug>.md.
|
|
5
|
-
Engineering standards MUST live in standards/documentation-framework.md.
|
|
6
|
-
Other domain folders (<domain>/) are repo-specific and may be created as
|
|
7
|
-
needed (ai/, auth/, data/, frontend/, infrastructure/, integrations/,
|
|
8
|
-
marketing/, operations/, personas/, reporting/, roadmap/, scanners/,
|
|
9
|
-
security/, strategy/, etc.).
|
|
10
|
-
Do NOT file customer-facing content here (that goes in knowledge/public/).
|
|
11
|
-
Write path: library/knowledge/private/<domain>/<kebab-slug>.md.
|
|
12
|
-
human_description: |
|
|
13
|
-
Internal engineering and business documentation.
|
|
14
|
-
- architecture/: Architecture Decision Records (ADRs)
|
|
15
|
-
- standards/: Documentation framework and coding standards
|
|
16
|
-
- <domain>/: Any repo-specific knowledge domain (ai/, auth/, data/, etc.)
|
|
17
|
-
Default landing zone for any doc that does not need to be customer-facing.
|
|
18
|
-
When creating a new domain folder, add a README.md explaining what belongs.
|
|
19
|
-
---
|
|
20
|
-
|
|
21
|
-
# Knowledge — Private
|
|
22
|
-
|
|
23
|
-
Internal documentation for engineers, product, and AI agents.
|
|
24
|
-
|
|
25
|
-
## Required sub-folders (always present)
|
|
26
|
-
|
|
27
|
-
| Folder | Contents |
|
|
28
|
-
|---|---|
|
|
29
|
-
| `architecture/` | ADRs: `ADR-<n>-<kebab-slug>.md`. Locked decisions with context, alternatives, consequences. |
|
|
30
|
-
| `standards/` | `documentation-framework.md` and any repo-specific writing rules. |
|
|
31
|
-
|
|
32
|
-
## Optional domain folders
|
|
33
|
-
|
|
34
|
-
Create any of these as needed: `ai/`, `auth/`, `data/`, `frontend/`, `infrastructure/`, `integrations/`, `marketing/`, `operations/`, `personas/`, `reporting/`, `roadmap/`, `scanners/`, `security/`, `strategy/`, `reference/`, `<product>-ux-ui/`.
|
|
35
|
-
|
|
36
|
-
## What does NOT belong here
|
|
37
|
-
|
|
38
|
-
- Customer-facing content (put in `knowledge/public/`)
|
|
39
|
-
- PRDs or IRDs (put in `requirements/` or `issues/`)
|
|
40
|
-
- Brand assets (put in `legion-shared/brands/`)
|
|
1
|
+
---
|
|
2
|
+
ai_description: |
|
|
3
|
+
This folder contains internal engineering and business documentation.
|
|
4
|
+
ADRs MUST live in architecture/ADR-<n>-<kebab-slug>.md.
|
|
5
|
+
Engineering standards MUST live in standards/documentation-framework.md.
|
|
6
|
+
Other domain folders (<domain>/) are repo-specific and may be created as
|
|
7
|
+
needed (ai/, auth/, data/, frontend/, infrastructure/, integrations/,
|
|
8
|
+
marketing/, operations/, personas/, reporting/, roadmap/, scanners/,
|
|
9
|
+
security/, strategy/, etc.).
|
|
10
|
+
Do NOT file customer-facing content here (that goes in knowledge/public/).
|
|
11
|
+
Write path: library/knowledge/private/<domain>/<kebab-slug>.md.
|
|
12
|
+
human_description: |
|
|
13
|
+
Internal engineering and business documentation.
|
|
14
|
+
- architecture/: Architecture Decision Records (ADRs)
|
|
15
|
+
- standards/: Documentation framework and coding standards
|
|
16
|
+
- <domain>/: Any repo-specific knowledge domain (ai/, auth/, data/, etc.)
|
|
17
|
+
Default landing zone for any doc that does not need to be customer-facing.
|
|
18
|
+
When creating a new domain folder, add a README.md explaining what belongs.
|
|
19
|
+
---
|
|
20
|
+
|
|
21
|
+
# Knowledge — Private
|
|
22
|
+
|
|
23
|
+
Internal documentation for engineers, product, and AI agents.
|
|
24
|
+
|
|
25
|
+
## Required sub-folders (always present)
|
|
26
|
+
|
|
27
|
+
| Folder | Contents |
|
|
28
|
+
|---|---|
|
|
29
|
+
| `architecture/` | ADRs: `ADR-<n>-<kebab-slug>.md`. Locked decisions with context, alternatives, consequences. |
|
|
30
|
+
| `standards/` | `documentation-framework.md` and any repo-specific writing rules. |
|
|
31
|
+
|
|
32
|
+
## Optional domain folders
|
|
33
|
+
|
|
34
|
+
Create any of these as needed: `ai/`, `auth/`, `data/`, `frontend/`, `infrastructure/`, `integrations/`, `marketing/`, `operations/`, `personas/`, `reporting/`, `roadmap/`, `scanners/`, `security/`, `strategy/`, `reference/`, `<product>-ux-ui/`.
|
|
35
|
+
|
|
36
|
+
## What does NOT belong here
|
|
37
|
+
|
|
38
|
+
- Customer-facing content (put in `knowledge/public/`)
|
|
39
|
+
- PRDs or IRDs (put in `requirements/` or `issues/`)
|
|
40
|
+
- Brand assets (put in `legion-shared/brands/`)
|