docs: sync documentation for v1.0.0 freeze
ci / build (ubuntu) (push) Has been cancelled
ci / unit + fmt (push) Has been cancelled
ci / examples (push) Has been cancelled
ci / goldens + tools (push) Has been cancelled
ci / apps (push) Has been cancelled
ci / selfhost smoke (push) Has been cancelled
ci / macos smoke (push) Has been cancelled
ci / windows smoke (push) Has been cancelled
ci / CI gate (push) Has been cancelled

Mark LanguageRef as normative, add docs index, update README/Packages/
Stdlib/BuildAndTest status lines, archive PLAN.md and QUALITY_PLAN
pointers to RELEASE_v1.0.0 and active SEMVER.
This commit is contained in:
2026-07-27 22:02:04 +03:00
parent a23860be3e
commit fa1521a71e
9 changed files with 59 additions and 22 deletions
+6 -3
View File
@@ -1,9 +1,12 @@
# Bux Programming Language — Roadmap to v1.0.0 # Bux Programming Language — Roadmap to v1.0.0
> **Version:** 0.3.1 (2026-06-06) > **Historical document.** Language **v1.0.0** shipped 2026-07-27 (tag `v1.0.0`).
> **Bootstrap:** Nim (`bootstrap/`) — compiles `src/` → `buxc` > For current status use: [`README.md`](README.md), [`docs/LanguageRef.md`](docs/LanguageRef.md),
> [`docs/RELEASE_v1.0.0.md`](docs/RELEASE_v1.0.0.md), [`docs/QUALITY_PLAN.md`](docs/QUALITY_PLAN.md).
>
> **Version (this file):** frozen archive of pre-1.0 planning
> **Bootstrap:** Nim (`bootstrap/`) — compiles `src/` → `buxc`
> **Self-host:** Bux (`src/`) — compiles via `buxc` → `buxc2` > **Self-host:** Bux (`src/`) — compiles via `buxc` → `buxc2`
> **Target:** Bux v1.0.0 — fully self-hosting, gradual ownership, tooling
--- ---
+9 -8
View File
@@ -284,9 +284,9 @@ bux/
├── tests/ # 🧪 Unit tests (Nim) ├── tests/ # 🧪 Unit tests (Nim)
├── examples/ # Example programs ├── examples/ # Example programs
├── apps/ # Real-world applications ├── apps/ # Real-world applications
├── docs/ # Documentation ├── docs/ # Documentation (LanguageRef = v1.0 normative)
├── README.md ├── README.md
├── PLAN.md # Roadmap to v1.0.0 ├── PLAN.md # Historical roadmap (pre-1.0)
└── Makefile └── Makefile
``` ```
@@ -296,14 +296,15 @@ bux/
| Doc | Description | | Doc | Description |
|-----|-------------| |-----|-------------|
| [`docs/LanguageRef.md`](docs/LanguageRef.md) | Language reference | | [`docs/LanguageRef.md`](docs/LanguageRef.md) | **Normative** language reference (v1.0) |
| [`docs/Stdlib.md`](docs/Stdlib.md) | Standard library API | | [`docs/Stdlib.md`](docs/Stdlib.md) | Standard library API |
| [`docs/BuildAndTest.md`](docs/BuildAndTest.md) | Build, test, and tooling | | [`docs/BuildAndTest.md`](docs/BuildAndTest.md) | Build, test, cross, tooling |
| [`docs/QUALITY_PLAN.md`](docs/QUALITY_PLAN.md) | Roadmap toward a “good” v1.0 |
| [`docs/Packages.md`](docs/Packages.md) | Package manager + registry | | [`docs/Packages.md`](docs/Packages.md) | Package manager + registry |
| [`docs/SEMVER.md`](docs/SEMVER.md) | Versioning policy | | [`docs/SEMVER.md`](docs/SEMVER.md) | Semver policy (**active** post-1.0) |
| [`docs/ROADMAP.md`](docs/ROADMAP.md) | Feature status (constructs) | | [`docs/RELEASE_v1.0.0.md`](docs/RELEASE_v1.0.0.md) | v1.0.0 freeze notes |
| [`PLAN.md`](PLAN.md) | Long-form phase plan | | [`docs/ROADMAP.md`](docs/ROADMAP.md) | Language construct status |
| [`docs/QUALITY_PLAN.md`](docs/QUALITY_PLAN.md) | Session history + path to v1.0 (archive) |
| [`PLAN.md`](PLAN.md) | Historical phase plan (pre-1.0) |
--- ---
+3
View File
@@ -1,5 +1,8 @@
# Build and Test Guide # Build and Test Guide
> **Compiler:** **v1.0.0** — `./buxc --version` → `bux 1.0.0 (bootstrap)`
> Selfhost: `make selfhost` → `buxc2` reports `Bux 1.0.0 (self-hosting)`.
This guide covers building the Bux bootstrap compiler, creating projects, and running tests. This guide covers building the Bux bootstrap compiler, creating projects, and running tests.
--- ---
+6 -1
View File
@@ -1,6 +1,11 @@
# Bux Language Reference # Bux Language Reference
This document describes the Bux programming language as implemented by the bootstrap compiler. > **Status:** Normative for **v1.0.0** (language freeze).
> Describes Bux as implemented by the **bootstrap** (`buxc`, Nim) and **self-hosted** (`buxc2`) compilers.
> Behaviour here is the contract for semver after 1.0 — see [`SEMVER.md`](SEMVER.md) and [`RELEASE_v1.0.0.md`](RELEASE_v1.0.0.md).
This document is the primary language specification. Compiler bugs that contradict
it are fixed without a MAJOR version bump; intentional breaking changes require MAJOR.
--- ---
+3 -2
View File
@@ -1,8 +1,9 @@
# Bux Package Manager # Bux Package Manager
> **Status:** Path + git + **local/file registry** (E.1) + **HTTP(S) index URL** (cached under `~/.bux/cache/`). > **Status (v1.0):** Path + git + **local/file registry** + **HTTP(S) index URL**
> (cached under `~/.bux/cache/`). Lockfile + `bux install --locked` for CI.
See also: [SEMVER.md](SEMVER.md) for version policy. See also: [SEMVER.md](SEMVER.md) for version policy (active as of language **v1.0.0**).
--- ---
+2 -2
View File
@@ -94,7 +94,7 @@
|---|--------|------|--------| |---|--------|------|--------|
| E.1 | Package registry protocol (git/HTTP) | `bux add foo` без path hacks | ✅ local index + **HTTP(S) URL** cache + file/git + `search` | | E.1 | Package registry protocol (git/HTTP) | `bux add foo` без path hacks | ✅ local index + **HTTP(S) URL** cache + file/git + `search` |
| E.2 | 35 production-quality apps в `apps/` | Showcase | ✅ 4 apps + `make test-apps` smoke (build + CLI) | | E.2 | 35 production-quality apps в `apps/` | Showcase | ✅ 4 apps + `make test-apps` smoke (build + CLI) |
| E.3 | Language freeze + semver policy | Trust | ✅ draft `docs/SEMVER.md` | | E.3 | Language freeze + semver policy | Trust | ✅ **v1.0.0** + active `docs/SEMVER.md` |
| E.4 | Debugger/DWARF basics | Systems audience | ✅ `#line``.bux` + `-g` / `--release`; `make test-dwarf` | | E.4 | Debugger/DWARF basics | Systems audience | ✅ `#line``.bux` + `-g` / `--release`; `make test-dwarf` |
| E.5 | Benchmarks vs C/Zig/Nim (micro + nexus) | Marketing + regression | ✅ micro + C/Nim/Zig twins + `make bench-nexus` (wrk) | | E.5 | Benchmarks vs C/Zig/Nim (micro + nexus) | Marketing + regression | ✅ micro + C/Nim/Zig twins + `make bench-nexus` (wrk) |
@@ -1212,7 +1212,7 @@ A (stdlib ergonomics) → B (compiler holes) → C (ownership depth)
--- ---
## Платформен фокус (v0.5 → v1.0) ## Платформен фокус (v0.5 → v1.0)
| Ниша | Какво значи за Bux | Статус / посока | | Ниша | Какво значи за Bux | Статус / посока |
|------|--------------------|-----------------| |------|--------------------|-----------------|
+17
View File
@@ -0,0 +1,17 @@
# Bux documentation index
**Language version:** **v1.0.0** (freeze) — tag `v1.0.0`
| Document | Role |
|----------|------|
| [LanguageRef.md](LanguageRef.md) | **Normative** language specification |
| [Stdlib.md](Stdlib.md) | Standard library overview / API tables |
| [BuildAndTest.md](BuildAndTest.md) | Build, test, cross, static, containers |
| [Packages.md](Packages.md) | Manifests, registry, lockfiles |
| [SEMVER.md](SEMVER.md) | Versioning policy (active after 1.0) |
| [RELEASE_v1.0.0.md](RELEASE_v1.0.0.md) | v1.0.0 release / freeze notes |
| [ROADMAP.md](ROADMAP.md) | Language construct checklist |
| [QUALITY_PLAN.md](QUALITY_PLAN.md) | Session log + path to v1.0 (archive) |
| [api/stdlib.md](api/stdlib.md) | Generated API docs from `///` (via `make docs`) |
Parent tree: [../README.md](../README.md) · historical plan: [../PLAN.md](../PLAN.md)
+5 -3
View File
@@ -1,9 +1,11 @@
# Bux Language Roadmap — New Constructs # Bux Language Roadmap — New Constructs
> **Updated:** 2026-07-27 | **Status:** ✅ Constructs for v1.0 shipped (language freeze) > **Updated:** 2026-07-27 | **Status:** ✅ Constructs for **v1.0.0** shipped (language freeze)
> Recent: macros (`tt`/`type`/juxta), stdlib daily APIs, Linux/riscv smoke; see `docs/RELEASE_v1.0.0.md`. > Recent: macros (`tt`/`type`/juxta), stdlib daily APIs, Linux/riscv smoke.
> Release: [`RELEASE_v1.0.0.md`](RELEASE_v1.0.0.md) · Spec: [`LanguageRef.md`](LanguageRef.md).
This document tracks planned language constructs beyond Phase 8 strategy. This document tracks language constructs (historical + status). For the normative
spec use LanguageRef; for post-1.0 optional work see QUALITY_PLAN session 88 backlog.
--- ---
+8 -3
View File
@@ -1,6 +1,11 @@
# Bux Standard Library # Bux Standard Library
The Bux standard library provides core functionality for systems programming. All modules are merged into every compilation, so no explicit linking is needed. > **Status:** Documented API for **v1.0.0**. Sources live under `lib/`; modules are
> merged into every compilation (no separate link step for stdlib).
The standard library targets systems and cloud-on-Linux programming (I/O, collections,
net/TLS with full runtime, crypto, tasks/channels). Thin/static builds use
`BUX_RUNTIME=minimal` — see [BuildAndTest.md](BuildAndTest.md).
--- ---
@@ -280,8 +285,8 @@ func Main() -> int {
let s: String = String_Replace("hello world", "world", "Bux"); let s: String = String_Replace("hello world", "world", "Bux");
PrintLine(s); // "hello Bux" PrintLine(s); // "hello Bux"
let fmt: String = String_Format2("{0} + {1} = magic", "Bux", "QBE"); let fmt: String = String_Format2("{0} + {1} = magic", "Bux", "C");
PrintLine(fmt); // "Bux + QBE = magic" PrintLine(fmt); // "Bux + C = magic"
let found: String = String_Find("hello world", "world"); let found: String = String_Find("hello world", "world");
if found as uint != 0 { if found as uint != 0 {