docs: improve README with quick start guide, V3 auth walkthrough, and community tools#117
Open
Valisthea wants to merge 1 commit intoasterdex:masterfrom
Open
docs: improve README with quick start guide, V3 auth walkthrough, and community tools#117Valisthea wants to merge 1 commit intoasterdex:masterfrom
Valisthea wants to merge 1 commit intoasterdex:masterfrom
Conversation
… error reference - Add step-by-step quick start for V3 API setup - Explain the 3 wallet values (user, signer, private_key) in a clear table - Add common signature error checklist (-1000 debugging) - Reorganize doc links into structured tables (Futures/Spot/RPC/Account) - Add official tools section (connector-python, aster-mcp, skills-hub) - Add community tools section (kairos-aster-sdk) - Add API endpoints summary table (prod + testnet URLs) - Note about @aster-desktop agent to reduce confusion - All original links preserved, paths updated to match current repo structure - No doc files modified 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.
What this changes
Replaces the current README (a flat list of links) with a structured onboarding guide that helps developers get started with the V3 API faster.
Why
The #1 question from developers integrating the V3 API is: What are user, signer, and private_key? followed by Why does my signature keep failing?
The current README doesn't answer either question. Developers have to dig through the full API spec to understand the auth flow, which leads to hours of trial and error on what should be a 5-minute setup.
What's added
What's NOT changed
Community tools disclosure
I added a "Community tools" row linking to kairos-aster-sdk, a Python SDK I built that abstracts the EIP-712 signing for V3. Happy to remove this if the team prefers to keep the README official-only. The SDK is MIT licensed and independently maintained.
Submitted by @Kairos_lab_org — Kairos Lab