Conversation
… ProtocolSoup Docs
- Astro 5 with Starlight, Scalar API reference plugin, and strict TypeScript - Sidebar structure, site metadata, edit links, and content collection loader - Local .gitignore for node_modules, dist, and .astro cache
- Landing page with hero, protocol cards, and live-site callout - Overview, quickstart, and platform-at-a-glance onboarding pages
- What You Can Do, Looking Glass, Flow Walkthroughs, Protocol Catalog - Covers end-user interaction patterns and UI feature explanations
- OAuth 2.0, OIDC, SAML, SCIM, SPIFFE, SSF, OID4VCI, OID4VP - Each page covers flow mechanics, RFC references, and ProtocolSoup specifics
- Deployment models, release/tag policy, environment variables, troubleshooting - Per-service pages for all 12 containers (gateway through spire-registration)
- API overview with authentication, base URLs, and error format - Integration patterns for polling, webhooks, and event streams - Versioning strategy and deprecation policy
- Full-page Scalar layout with custom topbar and service tab switcher - Gateway, Federation, SCIM, and VC specs navigable from a single view - CORS proxy enabled for live send/test against running instances
- Purple hero accent (#a855f7) with dark/light mode palette from the app - Space Grotesk headings, JetBrains Mono code, Inter body text - Logo SVGs with branded wordmark for dark and light themes
- All 12 service package docs restructured with consistent format - New SERVICE_TEMPLATE.md for contributor consistency across packages
- README documentation links now point to docs.protocolsoup.com - Legacy in-repo markdown annotated with canonical route notices
- Renamed $ ef member field to uri so YAML parsers treat it as data - Added descriptions to value, display, and uri fields in Group members
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What does this PR do?
New Astro/Starlight build at docs.protocolsoup.com. The new stack delivers an interactive Scalar-powered API reference with live support, and a branded theme aligned with the ProtocolSoup app (purple hero, Space Grotesk, JetBrains Mono).
Also rewrites all 12 GHCR package docs for consistency, updates the README to point at the canonical docs site
Fixes #
Type of change
How was this tested?
go run ./cmd/serverandnpm run devChecklist
git commit -s) per the DCOcd backend && go build ./...cd backend && golangci-lint run ./...cd frontend && npm run lintcd frontend && npx tsc --noEmit.envfilesScreenshots / Looking Glass output