Skip to content

docs: polish design documentation and add numerical analysis + workspace pages - #8

Merged
reiase merged 1 commit into
mainfrom
docs/design-polish
Aug 9, 2026
Merged

docs: polish design documentation and add numerical analysis + workspace pages#8
reiase merged 1 commit into
mainfrom
docs/design-polish

Conversation

@reiase

@reiase reiase commented Aug 9, 2026

Copy link
Copy Markdown
Contributor

Summary

Polishes the Blueprinting design documentation set with two new pages, one IR contract addition, and three small fixes.

New pages (4 files, bilingual)

  • docs/design/numerical-analysis.{en,zh}.md — documents the interactive IEEE floating-point format analysis (format layout comparison, bit-level decode, dynamic range, representable values, quantization error, operation range impact) and its place in the analysis architecture as a pure, deterministic presentation analysis view (not a cost provider, not a derived view of canonical IR).
  • docs/exploration/workspace.{en,zh}.md — documents the workbench workspace: four modes (point lens / batch lens / evidence lab / numeric lens), shared configuration surface, six testable workspace invariants, and a terminology note clarifying the two distinct meanings of workspace (UI workspace vs WORKSPACE buffer role in PortablePlanIR).

IR contract addition

  • docs/design/ir/planning-execution.{en,zh}.md — adds Abstract workspace and conservative bounds subsection under PortablePlanIR: formalizes the three-part obligation (conservative upper bound → target-specific workspace replacement → legality preservation), and notes the current inference slice implementation (workspace-upper-bound / block_working_upper_bound).

Fixes

  • providers.md (en/zh): fix broken FrozenDict import path (synthesizer.frozen → schema.frozen)
  • modules.md (en/zh): add Not yet callable admonition to ExplorationSession facade example
  • numerical-analysis.md: add cross-reference to workload.md for datatype context
  • mkdocs.yml: register both new pages in nav (en + zh translations)

Validation

  • i18n check: 33 bilingual page pairs validated
  • mkdocs build --strict: no warnings

…ace pages

- Add numerical-analysis.{en,zh}.md covering the interactive IEEE floating-point
  format analysis (format layout, bit decode, dynamic range, quantization error,
  operation range impact) and its place in the analysis architecture
- Add exploration/workspace.{en,zh}.md documenting the workbench workspace modes
  (point/batch/evidence/numeric lens), shared config surface, and invariants
- Add WORKSPACE buffer role semantics to PortablePlanIR contract
  (conservative upper bound → target-specific workspace replacement)
- Fix broken FrozenDict import path in providers.md (synthesizer → schema)
- Add "Not yet callable" note to ExplorationSession facade in modules.md
- Add cross-references between numerical-analysis, workspace, and related pages
- Update reading lists and mkdocs navigation
@reiase
reiase merged commit 8cf988f into main Aug 9, 2026
5 checks passed
@reiase
reiase deleted the docs/design-polish branch August 9, 2026 16:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant