44 lines
3.2 KiB
Markdown
44 lines
3.2 KiB
Markdown
# Topic Codes — registry for AyCode.Blazor's own topics (`ACBLAZOR`)
|
|
|
|
Per the Framework-First Design Principle, this Layer 1 registry lists **only AyCode.Blazor's own (`ACBLAZOR`) topics**. Lower-layer (inherited) topics live in their own repos' registries — at runtime, the `docs-check` skill walks `own-dep-repos` from the invocation point to gather all inherited topics. AyCode.Blazor inherits from `AyCode.Core` (see this repo's `@repo.own-dep-repos`).
|
|
|
|
Full ID format: `<PREFIX>-<TOPIC>-<TYPE>-<RAND>` — see `AyCode.Core/.github/REPO_PREFIXES.md` for the format spec.
|
|
|
|
## ACBLAZOR topic codes
|
|
|
|
| Code | Topic | Scope | Docs location |
|
|
|---------|-----------------------------|-----------------------------------------------------------------------------------|------------------------------------------------------------------------|
|
|
| `GRID` | MGGRID (grid component) | MgGrid component family: layout, CRUD, columns, toolbar, rendering | `AyCode.Blazor.Components/docs/MGGRID/` |
|
|
|
|
## Type codes (universal — see framework registry)
|
|
|
|
Type codes (`I`, `T`, `B`, `C`, `DEC`) are universal across all repos and defined in the framework's `TOPIC_CODES.md` (`AyCode.Core/.github/skills/docs-check/references/TOPIC_CODES.md`). This file does not duplicate them.
|
|
|
|
## ID format rules
|
|
|
|
See the framework's `TOPIC_CODES.md` (`AyCode.Core/.github/skills/docs-check/references/TOPIC_CODES.md`) for the full ID format rules and Status conventions. This file only registers ACBLAZOR's own topic codes; ACCORE topics are inherited via this repo's `own-dep-repos`.
|
|
|
|
## Examples (ACBLAZOR only)
|
|
|
|
```
|
|
ACBLAZOR-GRID-T-V4P7 # AyCode.Blazor's MgGrid TODO (e.g., "Generic ID generation in MgGridBase.SetNewId")
|
|
ACBLAZOR-GRID-T-S2L9 # AyCode.Blazor's MgGrid TODO (e.g., "Implement local grouping")
|
|
ACBLAZOR-GRID-I-XXXX # placeholder for the first MgGrid issue once one is observed
|
|
```
|
|
|
|
## Adding a new ACBLAZOR topic
|
|
|
|
1. Propose the code (2-5 uppercase chars), short and mnemonic, scoped to AyCode.Blazor's UI-framework domain.
|
|
2. Check it doesn't collide with C# class-name prefixes (`Ac*` / `Mg*`).
|
|
3. Check it doesn't collide with existing ACBLAZOR topic codes in the table above.
|
|
4. Check it doesn't visually collide with framework (`ACCORE-*`) topic codes that this repo references — though the `<PREFIX>` component disambiguates, visual distinction helps readers.
|
|
5. Add a row to the table above.
|
|
6. Create the topic folder under the relevant project: `AyCode.Blazor.<Project>/docs/{TOPIC_FOLDER_NAME}/` with `README.md`, optional `{TOPIC_FOLDER_NAME}_ISSUES.md`, `{TOPIC_FOLDER_NAME}_TODO.md`.
|
|
7. Optional: add an `LLMP-DEC-N` entry in the workspace-level `LLM_PROTOCOL_DECISIONS.md` if the new topic is workspace-meta-significant.
|
|
|
|
## Cross-references
|
|
|
|
- **Framework registry** (universal type codes, ID format spec, Status conventions): `AyCode.Core/.github/skills/docs-check/references/TOPIC_CODES.md` (resolved via this repo's `own-dep-repos`).
|
|
- **Repo prefix scheme**: `AyCode.Core/.github/REPO_PREFIXES.md`.
|
|
- **Decision Log**: `AyCode.Core/.github/LLM_PROTOCOL_DECISIONS.md`.
|