Further MD Fixes
This commit is contained in:
Raven Scott
@@ -12,13 +12,13 @@ This project is **experimental research software**. APIs described here follow t
|
||||
|
||||
**Capability map:** [docs/reference/kernel-capabilities-index.md](../docs/reference/kernel-capabilities-index.md).
|
||||
|
||||
**Contract checks:** changing **`bareOsCtxApiVersion**` or stock kernel feature bits should keep `**scripts/verify-ctx-api-feature-bits.mjs**` green (invoked from root `**pretest`**).
|
||||
**Contract checks:** changing **`bareOsCtxApiVersion`** or stock kernel feature bits should keep **`scripts/verify-ctx-api-feature-bits.mjs`** green (invoked from root **`pretest`**).
|
||||
|
||||
**Architecture contract (boundaries):** [`docs/architecture/KERNEL_CONTRACT.md`](../docs/architecture/KERNEL_CONTRACT.md) — booter vs guest image, **`disk.os`** RPC, boot step IDs.
|
||||
|
||||
**Kernel source set:** [`docs/reference/kernel-extensions.md`](../docs/reference/kernel-extensions.md) — first-party paths (`kernel/init.js`, `kernel/lib/boot`, built `/bin`) vs vendored **`kernel/lib/bare/bundles**` (Holepunch IIFEs), CI allowlists, and seeder parity. Hand-authored code must stay free of incomplete markers; bundles are gated by `**verify-bundle-markers.mjs**`, `**verify-bundle-throws.mjs**` ( `**new Error` messages** with *not implemented* / abstract-base-class semantics — see [`docs/audit/bundle-throw-allowlist.json`](../docs/audit/bundle-throw-allowlist.json)), and **`sanitize-bare-bundles.mjs`**. Prefer shrinking the throw allowlist via upstream bundle refreshes over silent drift.
|
||||
**Kernel source set:** [`docs/reference/kernel-extensions.md`](../docs/reference/kernel-extensions.md) — first-party paths (`kernel/init.js`, `kernel/lib/boot`, built `/bin`) vs vendored **`kernel/lib/bare/bundles`** (Holepunch IIFEs), CI allowlists, and seeder parity. Hand-authored code must stay free of incomplete markers; bundles are gated by **`verify-bundle-markers.mjs`**, **`verify-bundle-throws.mjs`** ( `**new Error` messages** with *not implemented* / abstract-base-class semantics — see [`docs/audit/bundle-throw-allowlist.json`](../docs/audit/bundle-throw-allowlist.json)), and **`sanitize-bare-bundles.mjs`**. Prefer shrinking the throw allowlist via upstream bundle refreshes over silent drift.
|
||||
|
||||
**Local Holepunch mirror:** run **`npm run audit:holepunch-clones**` to refresh `**docs/audit/holepunch-clone-sync-report.json**` (schema **2**), `**holepunch-lockfile-drift.json**`, and NDJSON summaries. The sync report lists every `**bare-module-manifest.json**` entry against `**BARE_OS_HOLEPUNCH_CLONES_ROOT**` (default `**~/dev/pearcli/holepunch-repos/holepunchto_repos**`): `**gitHead**`, `**originMainHead**`, `**commitsBehindOriginMain**`, `**commitsAheadOfOriginMain**` (meaningful after `**git fetch origin main**` in each clone). `**goldenPathRows**` mirrors `**goldenPathRepos**` in `**docs/audit/holepunch-drift-repos.json**` (Bare runtime + Pear + core wire stack) for quick maintainer diff review — it is **not** a CI gate. Root `**pretest**` runs `**verify-holepunch-clone-drift.mjs**` only against `**repos[]**` in the same JSON (empty = no-op). Maintainers may set `**BARE_OS_HOLEPUNCH_DRIFT_TIER1=1**` to check `**tier1Repos[]**` instead (hypercore / hyperdrive / hyperswarm / protomux / pear / pear-runtime / bare-fs / bare-process). Regenerate the maximal npm catalog with `**node scripts/gen-bare-holepunch-catalog.mjs**` (or `**npm run gen:bare-catalog**`), then `**npm run sync:bare-manifest`** — see [scripts/README.md](../scripts/README.md).
|
||||
**Local Holepunch mirror:** run **`npm run audit:holepunch-clones**` to refresh **`docs/audit/holepunch-clone-sync-report.json`** (schema **2**), **`holepunch-lockfile-drift.json`**, and NDJSON summaries. The sync report lists every **`bare-module-manifest.json`** entry against **`BARE_OS_HOLEPUNCH_CLONES_ROOT`** (default **`~/dev/pearcli/holepunch-repos/holepunchto_repos`**): **`gitHead`**, **`originMainHead`**, **`commitsBehindOriginMain`**, **`commitsAheadOfOriginMain`** (meaningful after `**git fetch origin main**` in each clone). **`goldenPathRows`** mirrors **`goldenPathRepos`** in **`docs/audit/holepunch-drift-repos.json`** (Bare runtime + Pear + core wire stack) for quick maintainer diff review — it is **not** a CI gate. Root **`pretest`** runs **`verify-holepunch-clone-drift.mjs`** only against `**repos[]**` in the same JSON (empty = no-op). Maintainers may set **`BARE_OS_HOLEPUNCH_DRIFT_TIER1=1`** to check `**tier1Repos[]**` instead (hypercore / hyperdrive / hyperswarm / protomux / pear / pear-runtime / bare-fs / bare-process). Regenerate the maximal npm catalog with `**node scripts/gen-bare-holepunch-catalog.mjs**` (or `**npm run gen:bare-catalog**`), then `**npm run sync:bare-manifest`** — see [scripts/README.md](../scripts/README.md).
|
||||
|
||||
---
|
||||
|
||||
@@ -71,8 +71,8 @@ Full script index: [scripts/README.md](../scripts/README.md). Gate everything wi
|
||||
- **[11 — Kernel + Pear cookbook](11-kernel-pear-cookbook.md)** — Boot allowlist, timers, socket IPC, `vfs.watch`, HDMS hooks, Git-in-Pear, release metadata.
|
||||
- **[12 — Bare modules and Pear ecosystem](12-bare-modules-and-pear-ecosystem.md)** — `ctx.bare`, manifest, drive bundles, Holepunch `bare-*` mirror vs guaranteed keys.
|
||||
- **[13 — Privacy, telemetry, and PII](13-privacy-telemetry-pii.md)** — Scrub lists for NDJSON / OTel mirrors; non-secret posture.
|
||||
- **[Node → Bare module map](node-to-bare-modules.md)** — Guest-safe replacements for **`node:***` built-ins (`**bare-crypto**`, `**bare-module`**, …).
|
||||
- **[bare-boot vs kernel phases](bare-boot-kernel-phase-alignment.md)** — Conceptual map: Holepunch **`bare-boot**` stages vs stock `**kernel/init.js`**.
|
||||
- **[Node → Bare module map](node-to-bare-modules.md)** — Guest-safe replacements for **`node:*`** built-ins (**`bare-crypto`**, **`bare-module`**, …).
|
||||
- **[bare-boot vs kernel phases](bare-boot-kernel-phase-alignment.md)** — Conceptual map: Holepunch **`bare-boot`** stages vs stock **`kernel/init.js`**.
|
||||
- **[Kernel program (governed expansion)](kernel-program.md)** — Governance, boot hooks, **`/proc/bare_os/kernel_program.json`**, Bare stack pointers, 200-item roadmap batches.
|
||||
- **[Naming conventions](naming-conventions.md)** — First-party vs vendored trees, `ctx` / env / proc naming.
|
||||
- **[Naming migrations](naming-migrations.md)** — Legacy aliases and deprecation windows for boot hooks and policy keys.
|
||||
|
||||
Reference in New Issue
Block a user