docs: task-oriented how-to guides for consumers and developers (PROT-50)#10
Draft
BlakeHastings wants to merge 1 commit into
Draft
docs: task-oriented how-to guides for consumers and developers (PROT-50)#10BlakeHastings wants to merge 1 commit into
BlakeHastings wants to merge 1 commit into
Conversation
Restructure the CLI docs into Aspire-style sidebar groups (Get started, How-to guides, Reference, Develop) with generated-index landing pages, and add real how-to guides: connect-your-harness, authenticate, choose-a-channel, manage-your-installation, command reference, configuration, troubleshooting. Rework the overview with a terms glossary. Remove the superseded flat pages. Part of PROT-50 (docs how-to pass under epic PROT-49).
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.
CLI docs: task-oriented how-to guides for consumers and developers (PROT-50)
Part of the PROT-50 documentation pass (epic PROT-49). Draft — content review pending, do not mark ready yet.
What changed
Restructured the flat doc list into Aspire-style sidebar groups (each with a generated-index landing page) and added genuine how-to guides:
installation·connect-your-harness(the capture hooks + the use→sync loop) ·authenticatechoose-a-channel(stable vs edge) ·manage-your-installation(update / move / uninstall)commands·configuration(env vars, file locations) ·troubleshootingbuild-from-source·releasing(moved in, sharpened)intro.mdoverview with a plain-language terms glossary.The old flat pages (
installation.md,channels.md,build-from-source.md,releasing.md) are removed in favor of the grouped versions. URLs change (e.g./cli/installation→/cli/get-started/installation); fine pre-launch.Notes
:::info 📷 Screenshot slot), not images yet — mine to add.docs/img/SCREENSHOTS.txtlists them. Build stays green until then./registry/...) resolve on the unified hub once the registry docs land on main.