docs: restructure documentation site with journey-based architecture#306
Draft
docs: restructure documentation site with journey-based architecture#306
Conversation
Overhaul the documentation from a technology-focused structure (docs/pages/) to a journey-based structure (docs/) organized around admin, user, and developer workflows. Add comprehensive architecture documentation for all domains. - Restructure install directory into base/overlays/components layout - Add admin journey docs (setup, environments, orgs, notifications, ops) - Add user journey docs (onboarding, APIs, events, approvals) - Add developer journey docs (contributing, operators, local dev) - Add architecture docs for all domains (admin, api, gateway, identity, etc.) - Add CRD reference generation scripts and remark plugin - Update CI workflows for new docs paths and enable deployment on feat branch - Simplify root README - Add local-setup script in hack/
…teps guides; add install overlay improvements - Replace setup.md with separate quickstart (Kind) and installation (ArgoCD) guides - Add first-steps tutorial for bootstrapping environment, zones, teams, and sample APIs - Expand environments-and-zones with zone setup details and EventConfig configuration - Rewrite notification-templates with selection logic, placeholders, and troubleshooting - Add user-journey features section (traffic management, security, event delivery, filtering) - Add secret-manager architecture page and update resource specs - Add Kustomize component with default notification templates - Rename zone files to .example.yaml; add EventConfig examples for local overlay - Fix install path in .releaserc.mjs; remove deprecated install.sh
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.
Overhaul the documentation from a technology-focused structure (docs/pages/)
to a journey-based structure (docs/) organized around admin, user, and
developer workflows. Add comprehensive architecture documentation for all
domains.