Repository navigation
Add Identity SDK docs - #254
Draft
ernestognw wants to merge 2 commits into
Draft
ernestognw wants to merge 2 commits into
ernestognw wants to merge 2 commits into
Conversation
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.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
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.
Adds the
@openzeppelin/identity-sdkdocs at/identity-sdk, and a guides-only mode in the docgen pipeline so a TypeScript package with hand-written MDX can be synced like Accounts.Stacked on #253 (base
accounts-docs), since it reuses the--guides-mdxcopy step added there. Retarget tomainonce #253 merges.Content is generated from OpenZeppelin/identity-sdk#21 at
c7575b2.TypeScript packages
TypeScript packages on this site (Upgrades Plugins, UIKit, UI Builder, the Accounts SDK) are hand-written MDX pages; none uses a generated API reference (no TypeDoc anywhere in the repo). The identity SDK follows that: its guides live in the source repo under
docs/(as Accounts' SDK guides do) and are copied as-is. There is noapi/folder.Pipeline (
cc6c44e)generate-api-docs.js --guides-only: clones the repo and copies the--guides-mdxdirectory into--guides-output, with no docgen, no dependency install and no API output. The output directory is cleared first so pages removed upstream disappear. The existing modes are unchanged.generate-api-docs-identity-sdk.ymlreceiver, modeled on the Accounts one, using--guides-only. No changelog step.Content (
f25f334)content/identity-sdk/: overview, concepts, gas, ABIs, and guides for deploying, account abstraction, keys, passkeys, claims, wallet linking, modules and the ERC-734 execution queue (12 pages).ethereum-evm.json, after OpenZeppelin Accounts.Testing
pnpm run lint:links: 0 errors. Also ran it with--no-ignore-fragments --scope identity-sdk: 0 errors (and it does flag a planted bad fragment and a bad path).biome check src/: clean./identity-sdk/**page returns 200 on the dev server, with the sidebar entries rendered.content/identity-sdkis byte-identical to the source repo'sdocs/atc7575b2.pnpm run buildstops at an unrelated page (/relayer/1.5.x/api/listNetworks, OpenAPI loader "Failed to resolve input") before finishing; no identity-sdk page is involved.Notes
use-navigation-tree.ts,docs-layout-client.tsx) are not touched;/identity-sdkfalls back to the default ecosystem detection.🤖 Generated with Claude Code