docs(claude-md): clarify ask docs is a new single-shot command#88
Merged
Conversation
Line 58 previously implied the entire `ask docs` surface was removed,
leaving the impression there is no `ask docs` command at all. In reality
only the legacy `ask docs {add,sync,list,remove}` sub-namespace is gone.
The updated gotcha now documents the full top-level command surface
(install | add | remove | list | docs | skills | src | cache), calls out
the distinction between the removed legacy namespace and the new
single-shot `ask docs <spec>` command, and records the current behaviour:
- walks `node_modules/<pkg>/` for npm specs; then the cached checkout at
`<askHome>/github/<host>/<owner>/<repo>/<ref>/` for github specs
- shares `ensureCheckout` with `ask src`, bypasses `runInstall` entirely,
so strict ref validation does NOT apply and unqualified github specs
default to `ref = 'main'`
- see implementation entry point: packages/cli/src/index.ts:323
dosubot
Bot
added
the
size:XS
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
![cubic-dev-ai[bot]](https://avatars.githubusercontent.com/in/1082092?s=60&v=4){kind=small}
Deploying ask-registry with
|
| Latest commit: |
b1a9981
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://ff43103e.ask-registry.pages.dev |
| Branch Preview URL: | https://docs-claude-md-ask-docs-gotc.ask-registry.pages.dev |
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
Corrects a misleading gotcha in
CLAUDE.md(line 58) that implied the entireask docssurface was removed. Only the legacyask docs {add,sync,list,remove}sub-namespace is gone;ask docs <spec>is a new single-shot command. The updated entry documents the full top-level command surface, the distinction between the removed and new commands, the current implementation behaviour (ensureCheckout-backed, no runInstall,maindefault for unqualified github specs, and strict ref validation does not apply).Test plan
Summary by cubic
Clarifies the gotcha in
CLAUDE.md: only the legacyask docs {add|sync|list|remove}was removed;ask docs <spec>is a new single-shot command. Updates the entry to list the full top-level commands (ask install | add | remove | list | docs | skills | src | cache) and note current behavior (usesensureCheckout, skipsrunInstall, defaults unqualified GitHub specs tomain).Written for commit b1a9981. Summary will update on new commits.