Add AI assistant guide, API field notes, and llms.txt - #32
Open
ddemlow wants to merge 1 commit into
Open
Conversation
New documentation for humans and AI coding assistants working against the SC//HyperCore(TM) REST API: - CLAUDE.md / AGENTS.md: rules and naming traps that prevent the most common HyperCore API bugs, read automatically by AI coding tools - docs/hypercore-api-field-notes.md: empirically verified per-endpoint behavior notes (task-tag waits, response shapes, version gates) - docs/hypercore-api-reference.html: rendered, searchable reference page - llms.txt: machine-readable repo summary Content reviewed for accuracy against HyperCore 9.6.x/9.7.x clusters and audited for trademark compliance. 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.
What this adds
Documentation for both humans and AI coding assistants writing code against the SC//HyperCore™ REST API:
CLAUDE.md— read automatically by Claude Code and other AI coding tools; distills the six rules that prevent most HyperCore API bugs (task-tag waits, single-element array responses, fetch-then-filter, self-signed TLS, update-in-progress checks, no cluster VIP) plus a naming-trap table.AGENTS.md— pointer file so non-Claude agents pick up the same guidance.docs/hypercore-api-field-notes.md— empirically verified per-endpoint field notes collected from real integration work against HyperCore 9.6.x/9.7.x clusters: request/response shape corrections, version-gated features, labels schema, snapshot/clone gotchas, ISO and virtual-disk upload flows, CBT/snapDiff.docs/hypercore-api-reference.html— self-contained rendered reference page (searchable, light/dark theme) of the same material.llms.txt— machine-readable summary for LLM crawlers.Review done
vm_lifecycle.py,Fleet Manager/) verified against this repo.🤖 Generated with Claude Code