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
2 changes: 1 addition & 1 deletion AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@ Env vars are a **scarce surface**: by default a new behavior knob becomes a conf

### Documentation Layout (owner ruling 2026-11-08, #5920)

- **One hub.** All design/config/protocol/identity docs live under `docs/`. The repo root keeps only `README.md`, `README.zh-CN.md`, `AGENTS.md`, `CHANGELOG.md` (plus temporary redirect stubs per rule 5). New docs go in `docs/`, never at the root.
- **One hub.** All design/config/protocol/identity docs live under `docs/`. The repo root keeps only four **core** entry files — `README.md`, `README.zh-CN.md`, `AGENTS.md`, `CHANGELOG.md` (plus temporary redirect stubs per rule 5) — and recognized community-maintained README translations (`README.<locale>.md`, e.g. `README.ja.md`, approved 2026-11-09, #6000); the four core files stay locked. New non-translation docs go in `docs/`, never at the root.
- **Naming & language.** kebab-case English base name; bilingual (en + `<same>.zh-CN.md`) is the default (en/zh parity per §7.3). A single-language doc must state why in its `docs/index` entry.
- **Index.** Every new or moved doc must be listed in `docs/index.md` AND `docs/index.zh-CN.md` in the same PR.
- **Split with `reference/`.** `docs/` = decision/reviewer-facing reference material; `reference/` = AGENTS lazy-loaded construction procedures + the KDD full text ([design-decisions.md](reference/design-decisions.md)). New how-to procedures → `reference/` (+ AGENTS.md pointer); new concepts/decisions → `docs/`.
Expand Down
2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Documentation

All system documentation for **billion-context** lives in this directory. The repo root keeps only four entry files: `README.md`, `README.zh-CN.md`, `AGENTS.md`, `CHANGELOG.md` (former root doc paths keep one-line redirect stubs at the root, tracked in [lifecycle §5](lifecycle.md#5-卫生记录)).
All system documentation for **billion-context** lives in this directory. The repo root keeps only four **core** entry files — `README.md`, `README.zh-CN.md`, `AGENTS.md`, `CHANGELOG.md` — and recognized community-maintained README translations (`README.<locale>.md`, e.g. `README.ja.md`, approved 2026-11-09, #6000). Former root doc paths keep one-line redirect stubs at the root (tracked in [lifecycle §5](lifecycle.md#5-卫生记录)).

> **Full catalog:** [index.md](index.md) / [index.zh-CN.md](index.zh-CN.md) — every doc with a one-line description. This page is the directory landing: where things are and which rules keep them live.

Expand Down
2 changes: 1 addition & 1 deletion docs/README.zh-CN.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# 文档导航

**billion-context** 的全部系统文档都集中在这个目录。仓库根目录只保留四个入口文件:`README.md`、`README.zh-CN.md`、`AGENTS.md`、`CHANGELOG.md`(原根路径保留单行重定向占位,记账见 [lifecycle §5](lifecycle.md#5-卫生记录))。
**billion-context** 的全部系统文档都集中在这个目录。仓库根目录只保留四个核心入口文件——`README.md`、`README.zh-CN.md`、`AGENTS.md`、`CHANGELOG.md`——外加受认可的社区 README 译本(`README.<locale>.md`,如 `README.ja.md`,批准于 2026-11-09 / #6000)。原根路径保留单行重定向占位(记账见 [lifecycle §5](lifecycle.md#5-卫生记录))。

> **全量目录:** [index.zh-CN.md](index.zh-CN.md) / [index.md](index.md) —— 每篇文档一行说明。本页是目录落地页:东西在哪、什么规则让它们保持新鲜。

Expand Down
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Documentation Index

> All system documentation lives under `docs/`. The repo root keeps only four entry files: `README.md`, `README.zh-CN.md`, `AGENTS.md`, `CHANGELOG.md`. Former root doc paths keep one-line redirect stubs (scheduled for removal after 1–2 releases; tracked in [lifecycle §5](lifecycle.md#5-卫生记录)).
> All system documentation lives under `docs/`. The repo root keeps only four **core** entry files — `README.md`, `README.zh-CN.md`, `AGENTS.md`, `CHANGELOG.md` — and recognized community-maintained README translations (`README.<locale>.md`, e.g. `README.ja.md`, approved 2026-11-09, #6000). Former root doc paths keep one-line redirect stubs (scheduled for removal after 1–2 releases; tracked in [lifecycle §5](lifecycle.md#5-卫生记录)).
> Lazy-load procedures (architecture / env-vars / testing / release / git-pr): [reference/](../reference/README.md).

## Start here
Expand Down
2 changes: 1 addition & 1 deletion docs/index.zh-CN.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# 文档总目录

> 全部系统文档集中在 `docs/`。仓库根目录只保留四个入口文件:`README.md`、`README.zh-CN.md`、`AGENTS.md`、`CHANGELOG.md`。原根路径保留单行重定向占位(计划 1–2 个版本后删除,记账见 [lifecycle §5](lifecycle.md#5-卫生记录))。
> 全部系统文档集中在 `docs/`。仓库根目录只保留四个核心入口文件——`README.md`、`README.zh-CN.md`、`AGENTS.md`、`CHANGELOG.md`——外加受认可的社区 README 译本(`README.<locale>.md`,如 `README.ja.md`,批准于 2026-11-09 / #6000)。原根路径保留单行重定向占位(计划 1–2 个版本后删除,记账见 [lifecycle §5](lifecycle.md#5-卫生记录))。
> 惰性加载的施工参考(架构 / 环境变量 / 测试 / 发版 / git-pr):[reference/](../reference/README.md)。

## 从这里开始
Expand Down
7 changes: 7 additions & 0 deletions scripts/live-files.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -117,6 +117,13 @@ export const LIVE_FILES = [
// network I/O and binds no port, so no zone band is needed — the entry is for
// the tripwire alone, like #3890/#5114
"tests/cache-keepalive.test.ts",
// #5955: the only real child is ONE bare `node -e ""` spawned purely to
// hand back an already-reaped pid (win32 taskkill-then-SIGKILL silence);
// the takeover ladder itself runs on INJECTED deps — no proxy is started,
// no port is bound, no shutdown/kill signal ever reaches the OS. Fixed
// fake origins only, so no zone band is needed — the entry is for the
// tripwire alone, like #3890/#5114/#5666
"tests/issue5955-wedged-same-lane-takeover.test.ts",
];

/** Band width per live file: the zone ladder drifts +1 per EADDRINUSE retry;
Expand Down
Loading