docs: move root .md files into docs/ + update every reference
Picks up the file renames that landed alongside the previous commit and fixes everything that pointed at the old root locations: - README.md doc-map updated: every entry now points at docs/X.md, with a new "docs/" lead entry pointing at the guided-tour index. - README inline cross-refs (ARCHITECTURE / INTEGRATION / SECURITY / BENCHMARKS / MES_INTEROP / PROOFS) repointed to docs/. - README "Interop" section rewritten — used to mention only secsgem-py; now covers all four external validators (secsgem-py 31 / secs4java8 55 / tshark 69 frames / libFuzzer 200 k+ runs) with a one-line summary each, plus pointers to interop/README.md and docs/VERIFICATION.md. - README "Deferred follow-ups" cleaned: dropped the explanatory "Listed here so reviewers don't go looking for them in COMPLIANCE.md and find an 'out of scope' entry that sounds defensive" sentence — the section header speaks for itself. - docs/00_index.md "Where the rest of the docs live" table: dropped every `../` prefix since the docs are now siblings. - docs/01_what_is_secs_gem.md PROOFS reference updated to sibling. - docs/02_the_cast.md INTEGRATION + MES_INTEROP refs updated to siblings; dropped the stale "at the repo root" wording. - interop/README.md: VERIFICATION + PROOFS refs updated to ../docs/X.md; stale "~24 + 4 checks" updated to 31 (matches PROOFS.md and README). - examples/pvd_tool/README.md: every doc cross-ref now points at ../../docs/X.md. - Source / data / CI comments mentioning doc names (e.g. "INTEGRATION.md §3", "COMPLIANCE.md gap") rewritten to "docs/INTEGRATION.md §3" etc. — affects 9 files across include/, apps/, tests/, data/, examples/, .gitea/workflows/. Verified: full build under docker passes, 445/445 test cases pass, 2 753/2 753 assertions pass. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
This commit is contained in:
+20
-20
@@ -172,9 +172,9 @@ new behaviour you have to add. Budget: as long as the integration
|
||||
takes.
|
||||
|
||||
**"I'm auditing for compliance / signing off on a deployment."**
|
||||
Read [`../COMPLIANCE.md`](../COMPLIANCE.md) first. Then read each
|
||||
Part 2 chapter for the standards in scope. Cross-check the code
|
||||
references against [`../PROOFS.md`](../PROOFS.md).
|
||||
Read [`COMPLIANCE.md`](COMPLIANCE.md) first. Then read each Part 2
|
||||
chapter for the standards in scope. Cross-check the code references
|
||||
against [`PROOFS.md`](PROOFS.md).
|
||||
|
||||
---
|
||||
|
||||
@@ -216,7 +216,7 @@ access can cross-check.
|
||||
- **Not a substitute for the SEMI standards** if you're certifying
|
||||
for production. We aim for accuracy, but if you're shipping into
|
||||
a fab, buy the official PDFs.
|
||||
- **Not a GEM RTS run.** [`../COMPLIANCE.md`](../COMPLIANCE.md) §8
|
||||
- **Not a GEM RTS run.** [`COMPLIANCE.md`](COMPLIANCE.md) §8
|
||||
explains the difference between "spec-implementing codebase" and
|
||||
"third-party-certified compliant equipment."
|
||||
- **Not a replacement for `../PROOFS.md`.** The proof table is the
|
||||
@@ -226,23 +226,23 @@ access can cross-check.
|
||||
|
||||
## Where the rest of the docs live
|
||||
|
||||
Existing root-level docs are reference / audit artifacts. This guide
|
||||
is the *tutorial path* that ties them together.
|
||||
The other docs in this directory are reference / audit artifacts;
|
||||
this guide is the *tutorial path* that ties them together.
|
||||
|
||||
| Root doc | What it is | When to read |
|
||||
|-----------------------------------------|-------------------------------------------------------------|--------------|
|
||||
| [`../README.md`](../README.md) | One-page project summary + quick start | First contact |
|
||||
| [`../PROOFS.md`](../PROOFS.md) | The eight commands that prove feature-completeness | Verifying claims |
|
||||
| [`../COMPLIANCE.md`](../COMPLIANCE.md) | Per-capability audit against every SEMI standard | Compliance review |
|
||||
| [`../ARCHITECTURE.md`](../ARCHITECTURE.md) | One-page architecture overview | Quick mental model |
|
||||
| [`../INTEGRATION.md`](../INTEGRATION.md) | Vendor-side integration tutorial | Going to production |
|
||||
| [`../VERIFICATION.md`](../VERIFICATION.md) | External validator test plan | Verification deep dive |
|
||||
| [`../BENCHMARKS.md`](../BENCHMARKS.md) | Performance envelope | Capacity planning |
|
||||
| [`../MES_INTEROP.md`](../MES_INTEROP.md) | Day-1 punch list for commercial MES integration | Pre-flight before MES connect |
|
||||
| [`../SECURITY.md`](../SECURITY.md) | Concrete nftables / stunnel / minisign / SIEM configs | Production hardening |
|
||||
| [`../GLOSSARY.md`](../GLOSSARY.md) | SEMI vocabulary cheat sheet | Quick term lookup |
|
||||
| [`../FAQ.md`](../FAQ.md) | Common questions, canonical answers | Stuck? Check here first |
|
||||
| [`../examples/pvd_tool/`](../examples/pvd_tool/) | A complete fictional PVD tool — YAML + main.cpp | Concrete reference deployment |
|
||||
| Doc | What it is | When to read |
|
||||
|--------------------------------------------------|-------------------------------------------------------------|--------------|
|
||||
| [`../README.md`](../README.md) | One-page project summary + quick start | First contact |
|
||||
| [`PROOFS.md`](PROOFS.md) | The eight commands that prove feature-completeness | Verifying claims |
|
||||
| [`COMPLIANCE.md`](COMPLIANCE.md) | Per-capability audit against every SEMI standard | Compliance review |
|
||||
| [`ARCHITECTURE.md`](ARCHITECTURE.md) | One-page architecture overview | Quick mental model |
|
||||
| [`INTEGRATION.md`](INTEGRATION.md) | Vendor-side integration tutorial | Going to production |
|
||||
| [`VERIFICATION.md`](VERIFICATION.md) | External validator test plan | Verification deep dive |
|
||||
| [`BENCHMARKS.md`](BENCHMARKS.md) | Performance envelope | Capacity planning |
|
||||
| [`MES_INTEROP.md`](MES_INTEROP.md) | Day-1 punch list for commercial MES integration | Pre-flight before MES connect |
|
||||
| [`SECURITY.md`](SECURITY.md) | Concrete nftables / stunnel / minisign / SIEM configs | Production hardening |
|
||||
| [`GLOSSARY.md`](GLOSSARY.md) | SEMI vocabulary cheat sheet | Quick term lookup |
|
||||
| [`FAQ.md`](FAQ.md) | Common questions, canonical answers | Stuck? Check here first |
|
||||
| [`../examples/pvd_tool/`](../examples/pvd_tool/) | A complete fictional PVD tool — YAML + main.cpp | Concrete reference deployment |
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -215,7 +215,7 @@ The separation matters because:
|
||||
139 tests for the E5 codec alone, 34 for HSMS, 27 for SECS-I,
|
||||
71 for E30 behaviour, and dozens per GEM 300 standard. None of
|
||||
the codec tests need a transport; none of the transport tests
|
||||
need a behaviour. See [PROOFS.md](../PROOFS.md) for the
|
||||
need a behaviour. See [PROOFS.md](PROOFS.md) for the
|
||||
per-standard test counts.
|
||||
|
||||
---
|
||||
|
||||
Reference in New Issue
Block a user