Skip to content

Commit 7aa09a7

Browse files
committed
docs: add internal docs index
1 parent 079e6b8 commit 7aa09a7

1 file changed

Lines changed: 35 additions & 0 deletions

File tree

docs/internal/index.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# Internal Docs Index
2+
3+
This folder contains **repository-internal** documentation.
4+
5+
- Do **not** wire anything under `docs/internal/` into `docs-site/` or `mkdocs.yml`.
6+
- Public docs are built only from `docs-site/`.
7+
8+
## Maintainership quick links
9+
10+
### Boundaries
11+
12+
- [Public docs boundary (what can be published)](public-docs-boundary.md)
13+
14+
### Runtime maps
15+
16+
- [Runtime module map (post-readability refactor)](runtime-module-map.md)
17+
18+
### OKRs
19+
20+
- [2026-03 Readability OKR (zh-CN)](2026-03-readability-okr.zh-CN.md)
21+
22+
### Security (internal)
23+
24+
- [Network + egress security notes](loopforge-network-security.md)
25+
26+
### Plans and references
27+
28+
- [Implementation plans](../plans/)
29+
- [Competitive archive](competitive/)
30+
31+
## Authoring rules (internal)
32+
33+
- Prefer **dated** filenames for plans/notes: `YYYY-MM-DD-<topic>.md`.
34+
- Keep “user-path” docs in `docs-site/`; keep maintainer maps, strategy, and competitor notes here.
35+
- When a doc is bilingual, put the language in the filename (example: `*.zh-CN.md`).

0 commit comments

Comments
 (0)