Skip to content

docs: split README into package guides with omit markers - #41

Merged
rdlabo merged 2 commits into
mainfrom
docs/readme-omit
Aug 19, 2026
Merged

docs: split README into package guides with omit markers#41
rdlabo merged 2 commits into
mainfrom
docs/readme-omit

Conversation

@rdlabo

@rdlabo rdlabo commented Aug 19, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Align the README landing with the docs portal Getting Started page.
  • Add portal-matching guides (http-auth, data-layer, realtime-offline, testing-operations) under docs/.
  • Keep CLI, role-policy, development, and API extras on GitHub behind omit comments, and publish docs/.

Test plan

  • Confirm README links to the four portal guides.
  • Confirm GitHub-only CLI/role-policy/development links remain in the omit region.
  • After publish, enable englishFromPackage for workers-hono-kit in rdlabo-docs.

Made with Cursor

rdlabo added 2 commits August 19, 2026 13:21
Align docs/ with the portal page list and keep CLI, role-policy, and development notes on GitHub only.
Point the API index at sibling markdown files, include the realtime entry point, and stop rendering front matter on GitHub.
@rdlabo
rdlabo merged commit 0269254 into main Aug 19, 2026
5 checks passed
@rdlabo
rdlabo deleted the docs/readme-omit branch August 19, 2026 04:38
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