Repository navigation
Docs: describe what Superhero offers, for the outside reader - #3
Open
Jeanclaudeaoun wants to merge 7 commits into
Open
Jeanclaudeaoun wants to merge 7 commits into
Jeanclaudeaoun wants to merge 7 commits into
Conversation
…acks Rewrites the API reference pages for an outside developer: every "there is no X" and "not emitted, do not build on it" becomes the thing to use instead, cost estimates become "pays gas at the network's current gas price", and the "legacy" labels on live fields are gone. The debug failed-transactions endpoint and the non-production Swagger note are removed; both are operator internals. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_018Az8TKjLpFXw9ouAdoyLDs
… well Every "the skill has no X" and "cannot be undone" becomes the thing to do instead, with the safety guidance kept: funding is the loss ceiling, transactions are final once mined, exits run on the cycle. The remaining gas estimate on the token-creation page is replaced with "paid at the network's current gas price". Headings now name the reader's action: "Hard boundaries", "Before you trade", "What moves with rotation". Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_018Az8TKjLpFXw9ouAdoyLDs
…de reader Every page in these sections now says what Superhero and the chain offer and how to use them. "There is no X" becomes the thing to do, permanence is presented as ownership and verifiability, "what Superhero does not use" becomes "other protocol features", and estimated gas figures (the worked gas example, the measured redemption cost, approximation-error measurements) are gone in favour of "pays gas at the network's current gas price". Protocol constants, skill balance checks and safety guidance for the reader's own keys stay. The testnet API cells no longer read "not publicly documented": they point to running the API from the public superhero-api repository. README now names the pages' "Related" section correctly, and the static export folder is ignored. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_018Az8TKjLpFXw9ouAdoyLDs
…it safe - Describe the built-in wallet, extension and mobile wallet by their strengths and the steps to set them up, back them up and connect. - Rename the site-data section to 'Site data and your backup' and point the troubleshooting and create-account anchors at it. - Drop the extension-vs-web trade-off table; each page now says what that wallet is for. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_018Az8TKjLpFXw9ouAdoyLDs
…ide reader - Rewrite tokens/risks as 'Before You Trade': what to check and how the curve, spread and slippage work, instead of a list of pathologies. - Rename the page in _meta.json and update every link text to it. - Remove the debug-endpoint section from tokens/transactions; the by-hash endpoint is the documented way to pull a mined trade in. - Keep protocol constants (1% spread, curve parameters); drop variable gas and cost figures across the DeFi pages. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_018Az8TKjLpFXw9ouAdoyLDs
…k gives - Rewards: eligibility and claiming described as steps; the 'not eligible' row and internal thresholds removed. - Identity: chain names, address links and X verification described by what the reader gets and how to set them up. - Resources: testnet cell points at running superhero-api; brand and support pages trimmed to what an integrator needs. - SECURITY.md: a reporting policy, written for the reporter. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_018Az8TKjLpFXw9ouAdoyLDs
… to use it - Social: posts framed as owned, verifiable on-chain records; chat as the realtime layer next to them; moderation as membership control; the internal retry/polling details the reader cannot act on removed. - DAO: the 555 AE framed as a contribution to the treasury; proposals, voting and ChangeDAO written as steps and checks for the voter; ProtocolDAO described by its properties and intended use. - Governance: polls, delegation and the registry described by what they record and how to use them; variable gas cost figures removed. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_018Az8TKjLpFXw9ouAdoyLDs
This branch has not been deployed
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
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 does
A final pass over all 152 pages for the outside reader: our community of developers, other developers and other companies. Every page now says what Superhero offers and how to use it. The rules come from the edits already made on
main(commit 3417126) and are applied across the tree:Lint:
python3 scripts/lint-mdx.py→ 0 issues across 152 pages.corepack pnpm buildpasses.out/added to.gitignore.Things to look at
These are the edits that change more than tone. Each one is easy to revert on its own.
contracts/security.mdx,tokens/risks.mdxtokens/risks.mdx_meta.jsonand the 14 pages linking to it). Rewritten as what to check and how the curve, spread and slippage work.dao/protocol-dao.mdxwallets/web-wallet.mdxrewards/rewards-program.mdxapi-reference/transactions.mdx,api-reference/index.mdx,tokens/transactions.mdxGET /api/debug/failed-transactionsremoved.GET /api/transactions/by-hashis the documented way to pull a mined trade into the index.api-reference/conventions.mdxdefi/*governance/polls.mdx,governance/registry.mdxsocial/chat.mdxSection headings renamed to match: "Nothing is locked" → "Your AE stays liquid", "The 555 AE is not refundable" → "The 555 AE contribution", "What moderation cannot do" → "The scope of a mute", "Not the same thing as a community DAO" → "Governance polls and community DAOs", and a few more of the same shape.
Commits
One commit per section so each can be reviewed on its own: api-reference; agents; concepts + getting-started + æternity + contracts; wallets; tokens + defi; rewards + identity + resources + SECURITY.md; social + dao + governance.
🤖 Generated with Claude Code
https://claude.ai/code/session_018Az8TKjLpFXw9ouAdoyLDs
Generated by Claude Code