Skip to content

re #15 docs: fill in package index#39

Merged
tonydspaniard merged 1 commit into
masterfrom
docs/index
May 26, 2026
Merged

re #15 docs: fill in package index#39
tonydspaniard merged 1 commit into
masterfrom
docs/index

Conversation

@tonydspaniard
Copy link
Copy Markdown
Member

Summary

Fills in docs/README.md to replace the four _Coming soon: …_ placeholders introduced in #16 with real bulleted entries for all 15 sibling-package docs (PRs #24#38).

Taxonomy

Lightly reorganized into four topical sections — each entry is a one-line punch describing what the package does:

  • HTTP stack — Http, Cookie, Session, Sanitation, Validation
  • Application core — Container, Configuration, Happen, Courier, Middleware
  • Data & types — Data, Structure, Common
  • Infrastructure — Cache, Filesystem, Security

Three of those slot differently than the original placeholders suggested (Sanitation and Validation moved from "Data & domain" to "HTTP stack" — they exist to clean and validate inbound HTTP input; Http moved from "Infrastructure" to "HTTP stack" where it belongs). Easy to reshuffle in review if you want a different grouping.

Merge order

This PR's links assume PRs #24#38 will be merged first — each link points to a sibling ./packages/<pkg>.md that lives in one of those PRs. If you merge this one first, all 15 links will 404 until the package PRs land. Suggested order: merge any subset of #24#38 (in any order), then merge this one last.

Test plan

  • Sibling package PRs merge (any order) before this one
  • Render docs/README.md on GitHub, check all 15 links resolve
  • Pure additive — no code touched

@tonydspaniard tonydspaniard merged commit 2e7c41f into master May 26, 2026
0 of 3 checks passed
@tonydspaniard tonydspaniard deleted the docs/index branch May 26, 2026 21:33
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