Skip to content

docs: migrating-to-v1 guide + codemods (Closes sdk#6) - #120

Open
greatKhalifa-code wants to merge 2 commits into
wraith-protocol:developfrom
greatKhalifa-code:feat/migrating-to-v1
Open

docs: migrating-to-v1 guide + codemods (Closes sdk#6)#120
greatKhalifa-code wants to merge 2 commits into
wraith-protocol:developfrom
greatKhalifa-code:feat/migrating-to-v1

Conversation

@greatKhalifa-code

Copy link
Copy Markdown

What

Adds the v1 migration reference and automated codemods paired with the API-stability sweep in sdk#6.

Files

File Description
reference/migrating-to-v1.mdx Full migration guide: 10 symbol renames, 4 removed exports, Stellar SDK v13 behavioral changes, migration checklist
reference/codemods/wraith-sdk-v0-to-v1.cjs jscodeshift transform — automates all 9 Wraith SDK renames, including await removal on getAgent
reference/codemods/wraith-v1-codemod.mdx Reference page for the codemod with usage, input/output examples, and known limitations
docs.json Fix duplicate pages key in Reference nav group; add new pages to Reference navigation

Acceptance criteria

  • Every public symbol change from sdk#6 documented
  • At least one codemod example (jscodeshift transform covering all 9 renames)
  • Nav entry added (reference/migrating-to-v1, reference/codemods/wraith-v1-codemod)

CI

pnpm check:snippets passes locally — 497 snippets checked, 0 failures. No , ... spread placeholders used in any TypeScript fences.

Closes sdk#6 (API-stability sweep).

- reference/migrating-to-v1.mdx: full rename table (10 symbols),
  removed exports (ChainEnum, WraithClientConfig, CreateAgentOptions,
  SorobanRpc), behavioral changes (Stellar SDK v13 memo/rpc/Memo
  immutability/signAuthEntries/SentTransaction), migration checklist
- reference/codemods/wraith-sdk-v0-to-v1.cjs: jscodeshift transform
  covering all 9 Wraith SDK renames including await removal on getAgent
- reference/codemods/wraith-v1-codemod.mdx: codemod reference page
  with usage, input/output examples, and limitations
- docs.json: fix duplicate pages key in Reference nav group; add
  migrating-to-v1 and wraith-v1-codemod to Reference navigation

pnpm check:snippets passes (497 checked, 0 failures).
@truthixify

Copy link
Copy Markdown
Contributor

Looks good, but the new pages are not in docs.json. Please add reference/migrating-to-v1 and reference/codemods/wraith-v1-codemod to the Reference nav, then push again.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants