Skip to content

Document public APIs and synchronize agent skills - #12

Merged
ConsoleTVs merged 2 commits into
mainfrom
chore/api-docs-and-agent-skills
Oct 24, 2026
Merged

ConsoleTVs merged 2 commits into
mainfrom
chore/api-docs-and-agent-skills

Conversation

@ConsoleTVs

Copy link
Copy Markdown
Member

Summary

public API comments → contracts, failure behavior, and caller examples
skills/lambda-router/ → merged guard/navigation/form/SSR behavior
AGENTS.md → mandatory same-change skill maintenance for every code modification

Audit all exported declarations and interface members. Correct stale Router-children, memory traversal, middleware-auth, signal-lifetime, speculative-cache and initial-redirect guidance. Runtime code and signatures remain unchanged.

Evidence

  • Before: Consumer skills and examples disagreed with merged runtime behavior; public symbols had incomplete examples.
    After: 64 public declarations and 69 interface members documented with examples, all four skill files synchronized, and mandatory maintenance instructions added.
  • Independently verified 36 production source files and 33 extracted executable examples typecheck. Comment-stripped AST comparison confirms all 36 changed source files preserve runtime code.
  • 279 tests pass; lint and format checks pass. Updated from main after v3.0.0 release.
  • Build completes with existing setup typing diagnostics; full project-reference typecheck retains the same baseline setup/context-nullability errors. Root tsc --noEmit checks zero files and is not treated as evidence of type safety.

Merge Danger

Door: two-way

Documentation-only; no runtime/API changes.

Blast Radius: guidance

Mandatory checks use .guard(), not speculative .prefetch() or render-time middleware. Server authorization remains independent. Existing implementation caveats are documented, not silently fixed in this PR.

@ConsoleTVs
ConsoleTVs marked this pull request as ready for review October 24, 2026 12:44
@ConsoleTVs
ConsoleTVs merged commit 5cf3352 into main Oct 24, 2026
7 checks passed
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