Skip to content

📝 docs: align SEP suite and README entrypoint#43

Merged
zrr1999 merged 4 commits into
mainfrom
docs/sep-suite-alignment
May 15, 2026
Merged

📝 docs: align SEP suite and README entrypoint#43
zrr1999 merged 4 commits into
mainfrom
docs/sep-suite-alignment

Conversation

@zrr1999
Copy link
Copy Markdown
Member

@zrr1999 zrr1999 commented May 14, 2026

Proposal summary

  • Rewrite README as the public proposal portal with current release-safety guidance, SEP status matrix, reading path, and validation commands.
  • Mark SEP-0001 as Accepted in front matter and index, while keeping SEP-0002 through SEP-0009 as Draft.
  • Align SEP-0001 root syntax decisions across the suite: file-derived modules, numeric suffixes, template interpolation, placeholder partial application, trait-method spec, timeout(expr), and when self refinements.
  • Tighten unresolved-question sections across Draft SEPs by moving resolved/delegated items out of the active open-question lists.
  • Update glossary terminology for BLAKE3 content addressing, function-level uses, effect handlers, modules, and select.

Linked discussion

Existing SEP discussions remain linked from each SEP front matter. This PR is a suite-wide consistency cleanup over the accepted SEP-0000 process and the SEP-0001 acceptance pass rather than a new standalone proposal thread.

Checklist

  • I opened or linked a public Discussion or Issue for the pitch before submitting this draft SEP.
  • I linked the canonical discussion thread.
  • I used the correct SEP template for this proposal type.
  • I updated front matter metadata and required sections.

Notes for reviewers

Docs-only change. Validation run locally:

  • prek run --all-files
  • uv run scripts/validate_sep_documents.py
  • uv run scripts/check_sep_index.py
  • uv run scripts/check_terminology_consistency.py
  • uv run scripts/check_contract_schemas.py

@chatgpt-codex-connector
Copy link
Copy Markdown

You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard.

zrr1999 added 3 commits May 15, 2026 12:07
- Introduced function-level attributes using the `@name(args)` form.
- Updated function headers to include `uses` clauses for better clarity.
- Clarified generic constraints syntax and added new reserved keywords.
- Improved documentation on error handling and channel usage in examples.
- Adjusted the collector function to reflect accurate task completion expectations.
- Updated SEP-0000 to remove the versioning requirement for the design archive.
- Enhanced SEP-0001 executive summary to clarify the core syntax and function-signature layout.
- Adjusted language in SEP-0003 to specify canonical semantics and effect aliases.
- Revised SEP-0005 to emphasize the additive schema for HoleReport and clarified the protocol for typed holes.
- Improved SEP-0006 to detail the handling of `spec` blocks and their impact on compiler behavior.
- Clarified the accepted surface in SEP-0007 regarding performance-critical patterns and handler binding.
- Updated SEP-0008 to reflect changes in versioning and aliasing conventions for packages.
- Updated SEP-0001 to improve the surface area table formatting and clarify local function declarations and cost analysis.
- Revised SEP-0002 to refine type representation and clarify the role of EffectSet and ErrorSet.
- Enhanced SEP-0003 to specify the effect system's semantics and clarify the intent-oriented effect vocabulary.
- Improved SEP-0004 to detail the cost analysis system and clarify the role of the `@unbounded` escape hatch.
- Updated SEP-0005 to refine the Hole System's protocol and clarify the structure of HoleReports.
- Revised SEP-0006 to enhance the compiler architecture description and clarify the diagnostics architecture.
- Improved SEP-0008 to clarify the module and package system and its visibility rules.
@zrr1999 zrr1999 merged commit a4d45e3 into main May 15, 2026
4 checks passed
@zrr1999 zrr1999 deleted the docs/sep-suite-alignment branch May 15, 2026 16:45
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