Skip to content

WP-14-docs_release

Choose a tag to compare

View all tags
@cubestudio-dev cubestudio-dev released this 23 Oct 10:19
· 112 commits to main since this release
WP-14-docs_release
d2f44c8

WP-14-docs_release

Documentation and release system: the complete documentation set, the
website rewrite, the GitHub wiki, and the release engineering process,
built strictly from the current code (nothing inherited from old docs).

What changed

  • Root documentation set, rewritten from scratch (7 files): README,
    BUILDING, INTERFACES (every one of the 162 L1 interfaces and the 233
    shell commands), ARCHITECTURE, FAQ, CONTRIBUTING, LICENSE (Apache-2.0).
  • docs/ knowledge base, 365 pages: user manual (244 pages including
    a page for every shell command), developer handbook (10), architecture
    deep dives (13), L1 extension guide (12), driver family manuals (15),
    troubleshooting (6), subsystem internals (7), release engineering (5),
    plus the generated data/ (commands.json, interfaces.json, stats.json)
    and the historical archive (44).
  • Website rewritten: the facade is pure HTML/CSS/JS (no framework);
    the docs center is VitePress over the repository docs/ tree (322
    rendered pages with full-text local search). Responsive from 390px
    phones to desktop - verified in a real browser at both widths.
  • GitHub Wiki: 76 curated pages mapped from docs/ and synced by
    tools/sync_wiki.sh (single source of truth: the docs/ tree).
  • Release engineering: the SOP (docs/release/process.md) with gates
    at every step; tools/build_release.sh (one-command gated release
    build), tools/update_website.sh (release data -> website), and
    tools/gen_api_docs.py (real-data extractor: 278 interface declarations
    parsed from 13 surface headers, 233-command table from a live
    help -a capture, per-directory line stats).
  • SPDX headers across the tooling; versioning and release-note
    conventions documented (docs/release/versioning.md).

New interfaces

None - WP-14 is documentation and release engineering only. The
command surface stays 233; L1 stays 162; syscalls stay 53. This is a
docs release: the kernel binary is unchanged from WP-13-build_system
(ELF byte-identical build, same boot banners).

Known issues

  • The OTA package embeds the build date (UTC day granularity): it is
    reproducible within a day, not across days.
  • The Windows build path (build.ps1) forwards to WSL2/MSYS2 and is
    statically verified only - no native Windows host was available.
  • TUI=n / CHINESE=n builds ship 216 commands (17 Chinese/TUI commands
    compiled out) - documented in BUILDING.md.

Verification (this release, on the release ISO)

Reproducible build PASS (ELF byte-identical across two clean builds) |
BIOS + UEFI boot gates PASS (233 commands, oc> ready) | regression
28/28 | watchdog/logging/health E2E 14/14 (TCO and WDAT real resets) |
dhtest 5/5 | SSH E2E 5/5 | HTTPS E2E 7/7 | website verified in a real
browser (desktop + 390px, zero console errors, search works, downloads
HTTP 200 with matching SHA256).

Assets

File Size SHA256
opencube-WP-14-docs_release.iso 12,326,912 3f876901db0af0b5b1779207e9faef77dc9f00cdb7731a7f47339e1ac0e00328
opencube-WP-14-docs_release-src.zip 3,976,264 91169570191b1d5a348169b602ee70b2bc4a7e7a5de82a79b4f047acdf7fb1c3
opencube-WP-14-docs_release-update.tar.gz 1,058,345 0873224deff05a6838aa80ea1bc26a7648f64ac3b1273a0746d4345d076c5117

Build 274. Apache-2.0, (c) cubestudio-dev cubestudio@qq.com.

Assets 5
Loading