Skip to content

docs: Add documentation page for experimental support #87

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

Kai-ros
Copy link

@Kai-ros Kai-ros commented Jun 13, 2025

Overview

Implemented nested page structure to improve page appearance and organization and added 4 pages to the docs site.

Callouts

  • This resolves #54
  • I am hoping these changes are sufficiently minimal but if I took things too far then I'm happy to split them out.
  • I tried my best to come to the necessary understanding of the code to describe it, but I am NOT an expert on Cloudflare Workers nor Service Workers, so please, be ruthless in your edits. Ready and willing to extend the explanations as requested!

Changes

  • General - Strove to maintain the existing sentiment and messaging of the docs while also improving consistency and clarity. Hopefully the necessary balance between detail and concision was struck. Also, fixed some grammar errors as I encountered them.

  • Getting Started Page - New page to focus solely on a minimal startup.

  • Why srvx? Page - New page to better explain the why for the library.

  • Experimental Support Page - New page explaining Cloudflare and Service Worker adapters.

  • Plugins Page - New page holding space for future Plugin details.

  • Nesting Structure - I took direct inspiration from the h3.dev site's nested navigation sidebar.

Before:
image

After:
image

Copy link

codecov bot commented Jun 16, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

📢 Thoughts on this report? Let us know!

@Kai-ros Kai-ros marked this pull request as ready for review June 19, 2025 17:44
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.

Document experimental cloudflare and service-worker
2 participants