Public Documentation Gap Inventory
Milestone: Public documentation and website roadmap Milestone 0.
This inventory records what 0x0 must add before it can replace the public
documentation role of jmp0x1b/lang. It excludes embedded and bare-metal
features from current 0x0 documentation.
Baseline
Source repositories inspected:
- old language repository:
/home/n0um3n4/repositories/lang; - current 0x0 repository:
/home/n0um3n4/repositories/0x0.
Observed public documentation surface:
jmp0x1b/lang/docs: 446 Markdown files at inspection time;jmp0x1b/lang/site: 22 public Markdown site pages;0x0/docs: 52 Markdown files at inspection time;0x0/site: not present before this milestone;0x0/libs: 178 library directories at inspection time.
The old public site is structured around Start, Learn, Build, Reference,
Hardware/Firmware, and Operate sections. 0x0 has implementation docs and
generated API docs, but no public site tree, no public Learn path, no public
registry site, and no domain migration plan yet.
Required 0x0 Public Areas
0x0 needs these current-behavior documentation areas:
- static website structure for
0x0.jmp0x1b.com; - Learn 0x0 course;
- public syntax, language, package, diagnostics, capability, runtime, API, and
release references;
- style guide, lint rule catalog, safe command guide, and standalone library
contract;
- cookbook and task-oriented pages based on current examples, libraries, and app
surfaces;
- generated or checked library registry metadata for
libs.jmp0x1b.com; - migration and obsolescence docs for
jmp0x1b/langandjmp0x1b/libs; - remote static-site deployment, verification, and rollback docs.
Current 0x0 Coverage
0x0 already has implementation-oriented docs for:
- implemented language slice in
docs/language.html; - compiler, ABI, object, archive, linker, optimizer, independent compiler, and
release paths;
- generated core API reference in
docs/api.html; - package manifests and lockfiles in
docs/packages.html; - core library representation in
docs/core-library.html; - runtime capability boundaries and app runtime surfaces;
- Index and Kukulkan replacement inventories, runtime docs, and release docs;
- maintainer workflow and documentation standards.
These documents are not enough as a public site because they are not organized
as a public learning path, reference portal, task guide, cookbook, registry, or
migration surface.
Major Gaps
Static Website
Gap: 0x0 has no site/ public portal equivalent to jmp0x1b/lang/site.
Required target artifacts are planned in docs/public-site-map.html,
site/manifest.tsv, and later site pages.
Learn Path
Gap: 0x0 has no replacement for the old 15-part learn-jmp0x1b course.
The replacement course must teach implemented 0x0 behavior only: source files,
forms, functions, bindings, annotations, imports, packages, capabilities, core
data helpers, tests, generated API docs, compiler artifacts, runtime
boundaries, app usage, diagnostics, release discipline, and migration.
Reference Docs
Gap: 0x0 lacks public-facing reference pages for grammar, syntax quick
reference, full language specification, package/API cross-reference, capability
model, runtime boundary, migration, and compatibility policy.
Existing implementation docs can be reused, but public reference pages must
avoid claiming complete type systems, embedded runtime support, or generic
runtime features that are not implemented.
Best Practices And Lint
Gap: 0x0 lacks a public source style guide, active lint rule catalog, safe
command guide, and standalone library contract.
Known risk: make docs-check can break the user session and must not be a
default public instruction until it is made resource-safe or replaced.
Cookbook And Tasks
Gap: 0x0 examples and library smoke tests are not organized into recipes.
Required cookbook categories include core language, packages, libraries, local
effects, runtime boundaries, generated API docs, Index, Kukulkan, and release
manifest workflows.
Library Registry
Gap: libs.jmp0x1b.com still represents the old library registry role. 0x0 has
migrated libraries locally, but no checked registry metadata, public package
pages, alias/deprecation policy, or old-registry unregistration plan.
Top-Level Migration
Gap: there is no public replacement story for:
jmp0x1b/langbecoming obsolete;0x0.jmp0x1b.combecoming the current docs site;libs.jmp0x1b.combecoming the 0x0 library registry;jmp0x1b.compointing users to 0x0;- embedded work being deferred instead of presented as current 0x0 behavior.
Deferred Old Areas
These old documentation areas are explicitly deferred and must not be described
as implemented 0x0 behavior:
- bare-metal target contracts;
- HAL capability contracts;
- RTOS/BSP integration;
- secure boot, update, and recovery;
- startup/linker/memory contracts for embedded targets;
- space mission operator runbooks;
- space assurance traceability;
- hardware BOM and physical proof material;
- mission I/O and transport contracts.
Actors, supervision, replay, distributed execution, and LiveView-style behavior
are not embedded-specific, but they still need current 0x0 evidence before they
can be presented as generic 0x0 language/runtime features. Until then they
belong in app-specific, partial, or deferred sections.
Source Map
The detailed source-to-target inventory is checked in
docs/public-docs-source-map.tsv.
Classification rules:
current: target file already exists and can be referenced today;planned: target file is required by a later milestone;app-specific: target belongs to Index/Kukulkan or an app runtime surface,
not generic 0x0 language documentation;
deferred: not implemented by 0x0 today;archive: retained only as historical or migration context;obsolete: should not be ported as a public 0x0 behavior claim.
The inventory gate fails if an embedded old source is mapped to a current 0x0
feature page.