client: improve docs AX — markdown-first help text#69
Merged
Conversation
- Fix top-level help: label docs as "markdown" (not XML), simplify workflow comment - Fix docs module help: correct command names (doc→docs), remove XML advertisement, add "open index.md first" orientation hint - Fix docs pull help: document .extrasuite/ as internal (do not edit), fix output_dir default claim, add comments.xml edit guidance - Fix docs push help: name .extrasuite/pristine.zip explicitly instead of "internal snapshot", clarify --verify flag purpose - Rewrite troubleshooting reference: replace XML-focused content with markdown-relevant errors and a diagnostic checklist - Hide pull-xml, push-xml, pull-md, push-md from docs subcommand listing; commands remain functional but no longer appear in --help output. Works around Python 3.13 argparse not honouring SUPPRESS for subparsers. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…de, hide stale refs - pull.md: fix default output_dir (was "current directory", is actually <document_id>/ in CWD) - pull.md: rewrite as a working guide — index.md orientation, line numbers, new-tab frontmatter snippet, full GFM feature list with callout syntax, images caveat, read-only elements - _common.py: hide troubleshooting, pull-xml, style-reference from `docs help` listing (XML-era content, not relevant to markdown workflow) Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Move all editing knowledge into docs README.md so agents don't need to cascade to pull --help on the happy path. One paragraph covers: index.md as the map with line numbers, editing tabs/*.md, creating tabs with frontmatter, supported GFM features, callout syntax, heading links, images read-only caveat, and re-pull reminder. Trim pull.md to a minimal flags reference (url, output_dir, --no-raw). Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Remove the subcommand --help reference. Module --help is the right starting point; agents don't need to know about the subcommand level. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <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.
Summary
Improves the agent experience (AX) for the docs module by making `extrasuite docs --help` the single reference — no cascading into subcommand help on the happy path.
Top-level `extrasuite --help`
`extrasuite docs --help` — now self-contained
`extrasuite docs push --help`
`extrasuite docs pull --help`
Hidden from `extrasuite docs help` listing
Hidden subcommands
Test plan
🤖 Generated with Claude Code