docs: genericize README — capabilities over deployment specifics - #183
Merged
Conversation
The README carried one specific deployment's mechanics: the per-port map repeated in four sections, legacy-bookmark migration notes, webhook-URL continuity remarks, and env-var plumbing. Features are now capability-led, the deployment model is described generically (the concrete port layout stays documented in the operator guide and auth runbook), and the ASCII architecture diagram is replaced with mermaid diagrams (architecture + render pipeline) that GitHub renders natively. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
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.
The README read like one specific deployment's runbook: the port map appeared in four separate sections (Overview, Features, Security, the architecture diagram), plus migration artifacts (legacy-bookmark 302 notes, webhook-URL continuity) and env-var plumbing that only matter to an existing install.
Changes:
${CADDY_TAILNET_HOSTNAME}→ "your tailnet hostname"-style phrasing; Hermes described as "an included default assistant"No information is lost: the per-port table remains in
docs/operator-guide.md(§ports) anddocs/deployment-models.md.🤖 Generated with Claude Code