-
-
Notifications
You must be signed in to change notification settings - Fork 0
docs: stdlib API reference (end-user depth gap) #652
Copy link
Copy link
Open
Labels
documentationDocs, prose, diagrams, READMEs, ADRsDocs, prose, diagrams, READMEs, ADRspriority:p2Normal - queue itNormal - queue itscope:repoConfined to this repositoryConfined to this repositorystatus:readyFully specified and ready to be picked upFully specified and ready to be picked up
Description
Activity
Metadata
Metadata
Assignees
Labels
documentationDocs, prose, diagrams, READMEs, ADRsDocs, prose, diagrams, READMEs, ADRspriority:p2Normal - queue itNormal - queue itscope:repoConfined to this repositoryConfined to this repositorystatus:readyFully specified and ready to be picked upFully specified and ready to be picked up
Audience
End users (people writing AffineScript).
Gap
Surfaced by the 2026-06-21 docs-depth gap-assessment (end-user / developer / maintainer triple). The onboarding ramp is now good — audience router (#649), tutorial lessons 1–10,
docs/guides/warmup/— but end-user docs stop at setup/basics. There is no canonical API reference for the stdlib that ships today:wiki/stdlib/overview.mdis a single overview page with no per-module/per-function signatures, semantics, or examples.This is distinct from:
docs/standards/stdlib-roadmap.adoc— what to build (roadmap), not how to use what exists.Suggested scope
docs/reference/stdlib/(.adocper repo DOC-FORMAT), one page per public stdlib module (stdlib/*.affine— e.g.Deno,Http,Crypto,Network,Sqlite, plus the core prelude).check/eval).docs/STDLIB-EXTERN-AUDIT.adocso it can't drift from the compiler.NAVIGATION.adocaudience router andwiki/stdlib/overview.md.Acceptance
Every public stdlib module has a reference page with signatures and ≥1 verified example, reachable from the audience router.