Skip to content

Commit 5a89dcb

Browse files
committed
Clarify historical docs status
1 parent 2376795 commit 5a89dcb

6 files changed

Lines changed: 20 additions & 5 deletions

File tree

CHANGELOG.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
6262
- Added explicit regression tests for return type mismatches inside if branches, match branches, and nested blocks.
6363
- Updated the tracked backlog to reflect existing bool/enum match exhaustiveness diagnostics.
6464

65+
- **Documentation state**
66+
- Marked the old error-analysis report as historical and corrected the archive index so it no longer points at removed generated artifacts.
67+
6568
- **Semantic and preprocessing correctness**
6669
- `defer` now traverses its parsed `statement` payload in both type checking and semantic validation.
6770
- `ret` semantic validation now traverses the parser's `value` payload.

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -163,6 +163,7 @@ All AST traversals are iterative with no recursion. The pipeline works with Pyth
163163
- `examples/` - 36 sample programs
164164
- `MISSING_FEATURES.md` - Feature status and roadmap
165165
- `CHANGELOG.md` - Change history
166+
- `docs/ERROR_ANALYSIS.md` - Historical error-analysis snapshot, not current status
166167

167168
## Docs Development
168169

RELEASE_READINESS_REVIEW.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,8 @@ not factually provable from local tests alone.
5656
inside if branches, match branches, and nested blocks.
5757
- Bool and enum match exhaustiveness diagnostics are covered for statements and
5858
expressions.
59+
- Historical error-analysis docs are labeled as non-current and no longer
60+
conflict with release status.
5961
- GitHub Pages deploy now uses `npm ci` with `site/package-lock.json`.
6062
- README, SPEC, release docs, status docs, and agent docs describe the same
6163
release commands.

TODO.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -250,5 +250,6 @@ These are entire subsystems. Each needs a design decision before implementation
250250
Files: `README.md`, `MISSING_FEATURES.md`, `docs/SPEC.md`, `plan.md`
251251
Notes: README, SPEC, site status/testing pages, and release docs now describe current backend/build gates and open caveats.
252252

253-
- [ ] Fix broken documentation links and mark historical docs as archived.
253+
- [x] Fix broken documentation links and mark historical docs as archived.
254254
Files: `README.md`, `docs/SPEC.md`, `docs/archive/README.md`, `docs/ERROR_ANALYSIS.md`
255+
Notes: `docs/ERROR_ANALYSIS.md` is now labeled as historical, README describes it as non-current, and the archive index no longer points to removed generated artifacts.

docs/ERROR_ANALYSIS.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,13 @@
11
# A7 Compiler Error Analysis
22

3+
> Historical snapshot.
4+
>
5+
> This report records an older compiler state and is kept only as debugging
6+
> history. It does not describe the current release status. For current example
7+
> verification, run `uv run python scripts/verify_examples_e2e.py`,
8+
> `uv run python scripts/verify_examples_e2e_c.py`, or `./run_all_tests.sh`.
9+
> Current gaps are tracked in `MISSING_FEATURES.md` and `TODO.md`.
10+
311
Analysis of semantic/type errors across all 36 example files.
412

513
## Summary Statistics

docs/archive/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,12 @@ This folder stores old or non-essential project artifacts that were moved out of
44

55
Moved on 2026-02-21:
66

7-
- `ERROR_ANALYSIS.md` -> `docs/ERROR_ANALYSIS.md`
87
- `run.sh` -> `docs/archive/tools/run.sh`
98
- `fix_types.py` -> `docs/archive/tools/fix_types.py`
10-
- `__pycache__/main.cpython-313.pyc` -> `docs/archive/pycache/__pycache__/main.cpython-313.pyc`
11-
- `site/` -> `docs/archive/site/`
129

1310
Notes:
1411

15-
- `docs/archive/site/node_modules` was intentionally removed because it is generated dependency output.
12+
- `docs/ERROR_ANALYSIS.md` is a historical error-analysis snapshot kept under
13+
`docs/` for reference; it is not current release status.
14+
- Generated cache output and the old archived site copy were removed from the
15+
repository. The current documentation site lives in `site/`.

0 commit comments

Comments
 (0)