Skip to content

docs(web): document terminal deploy-wallet linking on README, /docs, /how-it-works - #382

Merged
blockchain-maxis merged 1 commit into
blockchain-maxis:mainfrom
Glorious21:docs/terminal-linking-surfaces
Sep 2, 2026
Merged

docs(web): document terminal deploy-wallet linking on README, /docs, /how-it-works#382
blockchain-maxis merged 1 commit into
blockchain-maxis:mainfrom
Glorious21:docs/terminal-linking-surfaces

Conversation

@Glorious21

Copy link
Copy Markdown
Contributor

Summary

None of the README, /docs, or /how-it-works mentioned terminal linking, so a developer reading any of them could not discover the one action that turns an empty, freshly-claimed handle into a real career record. This adds that path to all three surfaces, names npx @signet/cli link, keeps the wording consistent, points at docs/CLI.md for the full sequence, and is explicit that the flow has not shipped yet.

Closes #289

Area

  • web

Changes

  • README — new CLI row in the Status table (state: not shipped); new Terminal deploy-wallet linking entry under What's coming next (Phase 2) describing the claim -> link -> indexed-profile flow; the indexer bullet now notes it attributes a linked wallet's contracts to the profile.
  • apps/web/app/(docs)/docs/page.tsx — new Linking your deploy wallet section (browser wallet vs. deploy keystore identity, the npx @signet/cli link command, what it proves, and that it is not live yet); Phases list item updated to include terminal linking as Phase 2 (in progress).
  • apps/web/app/how-it-works/page.tsx — new Terminal wallet linking item under What's coming.

Checklist

  • pnpm lint passes
  • pnpm typecheck passes
  • pnpm test passes
  • pnpm build passes
  • Contract changes (if any) pass cargo test and build to wasm within the size budget — n/a
  • Commits follow Conventional Commits (type(scope): subject)
  • The linked issue is still assigned to me

Notes for reviewers

  • docs/CLI.md does not exist yet (it is issue docs/CLI.md — install, link flow, CI usage, troubleshooting #288). All three surfaces reference it as inline code, not a Markdown link, so scripts/check-docs.mjs does not flag a broken link; the references read as "specified in / will be documented in docs/CLI.md".
  • No surface presents terminal linking as live — README Status says "Not shipped", the docs page says "Terminal linking is not live yet", and both list items sit under "coming"/"in progress".
  • Kept to the three surfaces named in the issue; no unrelated doc restructuring.

🤖 Generated with Claude Code

…/how-it-works

None of the three surfaces mentioned `npx @signet/cli link`, so a developer
reading any of them could not discover the step that turns a claimed handle
into an indexed profile. Add that path to the README (Status row + Phase 2
entry), the /docs page (new "Linking your deploy wallet" section + Phases
list), and /how-it-works ("What's coming"). All three name the command, tie
it to the claim -> link -> indexed-profile flow, point at docs/CLI.md for the
full sequence, and state that terminal linking is not shipped yet.

Closes blockchain-maxis#289

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@netlify

netlify Bot commented Aug 31, 2026

Copy link
Copy Markdown

Deploy Preview for stellar-signet ready!

Name Link
🔨 Latest commit 5dc3d80
🔍 Latest deploy log https://app.netlify.com/projects/stellar-signet/deploys/6a954b7712c80e0008e50390
😎 Deploy Preview https://deploy-preview-382--stellar-signet.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

@drips-wave

drips-wave Bot commented Aug 31, 2026

Copy link
Copy Markdown

@Glorious21 Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits.

You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀

Learn more about application limits

@vercel

vercel Bot commented Aug 31, 2026

Copy link
Copy Markdown

@Glorious21 is attempting to deploy a commit to the blockchainmaxis-8449's projects Team on Vercel.

A member of the Team first needs to authorize it.

@blockchain-maxis

Copy link
Copy Markdown
Owner

Thanks @Glorious21 — merging. #289 was about three surfaces staying silent on the thing that actually turns a claimed handle into a populated profile, and this fixes all three with the same explanation each time: the browser wallet that signs the claim is rarely the keystore identity stellar contract deploy runs from, so the profile renders empty until a deploy wallet is linked. Saying that plainly is worth more than the command itself.

I especially like that every mention is labelled as not shipped — the Status table row, the bold "Terminal linking is not live yet" on /docs, and placing it under "What's coming" on /how-it-works. Documenting an unshipped feature is the easy way to make a README lie, and this doesn't.

One note for whoever lands docs/CLI.md (#288 / #352): all three surfaces now point at it and it isn't on main yet. It's referenced in backticks rather than as a relative link, so the docs guard passes (23 markdown files, 27 env vars, no drift) — but the references become real promises once that file exists, so they're worth re-reading then.

Closes #289.

@blockchain-maxis
blockchain-maxis merged commit e6579e7 into blockchain-maxis:main Sep 2, 2026
9 of 10 checks passed
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.

README, /docs, and /how-it-works do not mention terminal linking

2 participants