This index lists document entry points and responsibilities. Keep full specifications in one place; package READMEs retain the short examples needed to get started.
| Document | Scope |
|---|---|
| Validation (Chinese) | Repository setup, development commands, check selection, build reuse, and PN coverage audits |
| Integration | SDK, browser resources, server startup, and deployment |
| HTTP API | Routes, parameters, responses, status behavior, and CORS |
| Cloudflare Workers | Wrangler configuration, local development, deployment, and external links |
| FlashDetector compatibility server | Classic migration, legacy routes, and Workers / Node.js deployment |
| FDBGen | FDB generation, MDB crawling, input structures, and normalization |
| FDBGen v1 support-list format | Standard JSON input for extraction tools |
| DecodePack | JSON syntax, compiler API, rule registration, and diagnostics |
| PN references (Chinese) | Vendor/product references and maintenance boundaries |
| PN authoring (Chinese) | Token structure, package evidence, search resource deduplication, and completion criteria |
| Reference policy (Chinese) | Evidence admission levels and source metadata ownership |
| Public field terminology | Public field keys and display terms |
| NAND die profiles (Chinese) | Shared keys, firmware naming, and fallback normalization |
| DRAM coverage method (Chinese) | Organization of vendor generation research |
| Contract tests | Source API and package checks |
| PN coverage audit (Chinese) | Dated coverage measurements and research findings |
| Field information audit (Chinese) | Dated migration evidence and information preservation |
| FDB 87 association audit (Chinese) | Dated PN–ID examples and dataset metrics |
- The root README introduces the project. Package READMEs cover purpose, setup, and minimal usage. Package-specific content without another owner, such as Classic deployment and the contract-test source API, stays there.
- Integration, runtime, HTTP, and maintenance references live in
docs/.SERVER_API.mdowns shared HTTP behavior; deployment guides link to its route table. - Vendor PN structures, source explanations, code tables, and examples belong in
docs/pn_code/<vendor>_<product>.md. Source admission belongs inreference_policy.md; public naming belongs interminology.md. - Audits record dates, measurements, methods, and unresolved observations. Current rules belong in specifications and vendor references. Preserve unique facts before consolidating content; historical measurements are not current coverage.
AGENTS.mdowns repository work boundaries,pn_code/authoring.mdowns PN authoring, andTESTING.mdowns validation. Other documents link to these rather than copying procedures. Read only sections relevant to the task.
- Write the root and package READMEs, this index, integration/deployment guides, HTTP API, DecodePack, FDBGen and its input format, and public field reference in English. Internal instructions, maintenance procedures, vendor research, and audits may use Chinese; label links to them
Chinese. - Maintain one primary language version. Keep technical identifiers, official source titles, quotations, license text, and literal localized field labels unchanged. Translation must preserve behavior, field values, evidence strength, and unknown/inferred/confirmed distinctions.
- Package README cross-file links use full GitHub URLs, such as
https://github.com/iTXTech/fdnext/blob/master/docs/INTEGRATION.md; same-page anchors remain local. Root anddocs/links may be relative. Update incoming anchors when headings change.