docs(release): sync roadmap, changelog, guides, and README for 1.0.0#381
Merged
Conversation
Bring every user-facing doc and status artifact in line with reality ahead of the 1.0.0 cut: ROADMAP status (20/29 suite, gate MET), CHANGELOG (#376/#379 entries, suite-exclusion doc, 0.x upgrade guide, heading/link-ref normalization), the sandboxing guide (:max_instructions as the primary CPU defense), README (utf8 coverage, qualified filesystem claim, ~LUA import), and the mix.suite guide (skips-file reality, current sample output). Also fixes the 5.4->5.3 manual link, the <eval> default-source docstring, a disjoint-type test warning, and wires up the Lua.Parser.Error doctest. Plan: A49
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Docs sync for 1.0.0: roadmap, changelog, guides, README true-up
Plan:
.agents/plans/A49-release-docs-sync.mdPlan: A49
Goal
Bring every user-facing doc and status artifact in line with reality
(20/29 official suite files passing,
rc.3→1.0.0pending) so the1.0.0cut is documentation-clean.Changes (per scope item)
2026-07-05and updated to20/29 (9 fully clean + 11 with skip-ranges; 5 whole-file skips + 4
permanent non-goals). Suite gate under "Current focus" marked MET.
Lua.tregardless ofentry point) under Changed, fix(string.rep): allocate proportionally to result, not repeat count #376 (
string.repproportionalallocation) under Fixed.
exclusions listed by category (filesystem/subprocess; capability;
perf-bound; PUC error-wording) — satisfies the A13 gate's
"exclusions documented in CHANGELOG".
vprefix from## [vX]headings so they resolve against the no-vlink refs, andmade
## Unreleased→## [Unreleased]to use the defined ref.the top (with a pointer note) synthesizing the rc.0 breaking changes.
"Limiting CPU work" leads with
Lua.new(max_instructions: n)as thein-VM CPU defense (catchable
"instruction budget exceeded"), keepingthe process/
Taskwrapper as the complementary wall-clock defense."Putting it together" now includes
:max_instructions.utf8to the implemented-stdlib list; qualifiedthe host-filesystem claim (deny-by-default;
Lua.set_lua_paths/2/Lua.load_file!/2opt in); addedimport Luato the Tour so pasted~LUAexamples compile.load_file!doc now links the Lua 5.3 manual.:sourcedefault is now<eval>(was<stdin>).@ready_testsreferencewith the
test/lua53_skips.exsreality, refreshed the sample outputto a real raw run (9 passing / 17 failing / 3 timeout), documented
--status/--audit, and noted the canonical 20/29 count. Samestaleness fixed in the
mix lua.suitemoduledoc (tasks/lua.suite.ex).refute encoded == "nil"(redundant after
assert encoded == nil) that produced a type warning.doctest Lua.Parser.Errortotest/lua/parser/error_unit_test.exs; the example passes.B17→status: merged(noting the option shippedrenamed to
:max_instructions);A33→status: merged(pointing atbenchmarks/BASELINE.md).Verification
The item-8 type warning is gone from the compile output; the new
Lua.Parser.Errordoctest is included in the 65 doctests.Out of scope (intentional)
doctest wiring).
subsections to keep the merge conflict small.