mirror of
https://github.com/harivansh-afk/nix.git
synced 2026-04-16 00:03:03 +00:00
60 lines
3.2 KiB
Markdown
60 lines
3.2 KiB
Markdown
/Users/rathi/Documents/GitHub/claude-code-docs/docs/ contains a local updated copy of all Claude Code documentation.
|
|
|
|
Usage:
|
|
- /user:docs <topic> - Read documentation instantly (no checks)
|
|
- /user:docs -t - Check documentation freshness and sync status
|
|
- /user:docs -t <topic> - Check freshness, then read documentation
|
|
|
|
Default behavior (no -t flag):
|
|
1. Skip ALL checks for maximum speed
|
|
2. Go straight to reading the requested documentation
|
|
3. Add note: "📚 Reading from local docs (run /user:docs -t to check freshness)"
|
|
|
|
With -t flag:
|
|
1. Read /Users/rathi/Documents/GitHub/claude-code-docs/docs/docs_manifest.json (if it fails, suggest re-running install.sh)
|
|
2. Calculate and show when GitHub last updated and when local docs last synced
|
|
3. Then read the requested topic (if provided)
|
|
|
|
Note: The hook automatically keeps docs up-to-date by checking if GitHub has newer content before each read. You'll see "🔄 Updating docs to latest version..." when it syncs.
|
|
|
|
Error handling:
|
|
- If any files are missing or commands fail, show: "❌ Error accessing docs. Try re-running: curl -fsSL https://raw.githubusercontent.com/ericbuess/claude-code-docs/main/install.sh | bash"
|
|
|
|
GitHub Actions updates the docs every 3 hours. Your local copy automatically syncs at most once every 3 hours when you use this command.
|
|
|
|
IMPORTANT: Show relative times only (no timezone conversions needed):
|
|
- GitHub last updated: Extract timestamp from manifest (it's in UTC!), convert with: date -j -u -f "%Y-%m-%dT%H:%M:%S" "TIMESTAMP" "+%s", then calculate (current_time - github_time) / 3600 for hours or / 60 for minutes
|
|
- Local docs last synced: Read .last_pull timestamp, then calculate (current_time - last_pull) / 60 for minutes
|
|
- If GitHub hasn't updated in >3 hours, add note "(normally updates every 3 hours)"
|
|
- Be clear about wording: "local docs last synced" not "last checked"
|
|
- For calculations: Use proper parentheses like $(((NOW - GITHUB) / 3600)) for hours
|
|
|
|
First, check if user passed -t flag:
|
|
- If "$ARGUMENTS" starts with "-t", extract it and treat the rest as the topic
|
|
- Parse carefully: "-t hooks" → flag=true, topic=hooks; "hooks" → flag=false, topic=hooks
|
|
|
|
Examples:
|
|
|
|
Default usage (no -t):
|
|
> /user:docs hooks
|
|
📚 Reading from local docs (run /user:docs -t to check freshness)
|
|
[Immediately shows hooks documentation]
|
|
|
|
With -t flag:
|
|
> /user:docs -t
|
|
📅 Documentation last updated on GitHub: 2 hours ago
|
|
📅 Your local docs last synced: 25 minutes ago
|
|
|
|
> /user:docs -t hooks
|
|
📅 Documentation last updated on GitHub: 5 hours ago (normally updates every 3 hours)
|
|
📅 Your local docs last synced: 3 hours 15 minutes ago
|
|
🔄 Syncing latest documentation...
|
|
[Then shows hooks documentation]
|
|
|
|
Then answer the user's question by reading from the docs/ subdirectory (e.g. /Users/rathi/Documents/GitHub/claude-code-docs/docs/hooks.md).
|
|
|
|
Available docs: overview, quickstart, setup, memory, common-workflows, ide-integrations, mcp, github-actions, sdk, troubleshooting, security, settings, monitoring-usage, costs, hooks
|
|
|
|
IMPORTANT: This freshness check only happens when using /user:docs command. If continuing a conversation from a previous session, use /user:docs again to ensure docs are current.
|
|
|
|
User query: $ARGUMENTS
|