Skip to content

Overhaul the developers section: engage, orient, product-separated structure#256

Merged
guylouis merged 15 commits into
mainfrom
improve/dev-docs
Jul 13, 2026
Merged

Overhaul the developers section: engage, orient, product-separated structure#256
guylouis merged 15 commits into
mainfrom
improve/dev-docs

Conversation

@guylouis

@guylouis guylouis commented Jul 4, 2026

Copy link
Copy Markdown
Contributor

What this does

Restructures and rewrites keycard.tech/developers so a developer discovering the product understands what Keycard/Shell are, why they're interesting to build on, and where everything lives.

Structure (sidebar)

  • Product-separated navigation: Keycard (Getting Started, Core Concepts, Build Your Own Keycard) with its Keycard SDK and Keycard API (APDU) sections, then Keycard Shell (Integrate a Wallet with Shell, Shell API Reference, Build Your Own Shell), then shared Hardware Specification and Ecosystem & Community
  • "Keycard Shell internals" dissolved into a wallet-integration guide + a Shell API reference; firmware/build content merged into Build Your Own Shell
  • Deleted: deprecated Web3 API page, redundant Tools and Contact pages (all with 308 redirects)

Content

  • New overview landing: what/why, open-source and standard-protocols pitch, social proof, choose-your-path
  • New Ecosystem & Repositories page (repo map, SDK table) and Contribute page (eth-abi-repo ABIs as flagship easy contribution)
  • Hardware Specification rebuilt as a full spec sheet with all certifications
  • QR docs split by chain: UR as the common transport, EIP-4527 for EVM, PSBT for Bitcoin
  • Status de-emphasized to one integrating wallet among others; Cash applet no longer on the overview
  • Card requirements now link to the status-keycard README instead of duplicating it (docs copy had drifted)

Verification

  • pnpm build passes; all pages return 200; old URLs redirect; Shell API content fact-checked against USB.md and ur.cddl in the keycard-shell repo

🤖 Generated with Claude Code

guylouis and others added 13 commits July 4, 2026 10:09
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Groups resources into 'Under the Hood' and 'Ecosystem & Community',
adds the new Contribute entry, and redirects /developers/web3 to the
overview since the Status EIP-712 extension is disabled.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Card requirements now point to the status-keycard README, which is
the maintained source (docs had already drifted to an older JavaCard
version).

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Hardware Specification now covers complete device characteristics and
all certifications. Tools content lives on the ecosystem page and
contact info on Contribute/Overview; both old URLs redirect.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
…erence

'Keycard Shell internals' was a junk drawer. Its content now lives in
three purposeful places: a guide for wallet developers
(shell-wallet-integration), a machine-interface reference (shell-api),
and build/firmware details merged into the DIY Shell page. Sidebar
reordered: overview, software block, ecosystem, build-your-own, then
hardware specification. Old URL redirects to the API reference.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Sidebar now groups by product: Keycard (getting started, concepts,
build your own) with its SDK and APDU reference, then Keycard Shell
(wallet integration, API reference, build your own), then shared
Hardware Specification and Ecosystem. 'Java SDK' renamed Keycard SDK
(Java) with a contextual intro; 'DIY' copy aligned to 'Build Your Own'.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
…rojects

- APDU section renamed 'Keycard API' in nav and prose; overview page now
  opens by explaining what an APDU is
- SDK index leads with the full SDK table and a note that Java is the
  documented reference implementation
- Wallet integration page drops the trust-model preamble
- Ecosystem page drops 'What has been built'; Contribute opens with a
  tip callout to keycard-ecosystem-projects

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
UR is the chain-agnostic QR transport; EIP-4527 defines the EVM payload
types and Blockchain Commons specs the Bitcoin ones. Wallet integration
and Shell API pages now present them as separate EVM/Bitcoin sections
instead of mixing the standards.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@vercel

vercel Bot commented Jul 4, 2026

Copy link
Copy Markdown
Contributor

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
keycard-website Ready Ready Preview, Comment Jul 13, 2026 9:33am

Request Review

Comment thread content/developers/apdu/overview.mdx Outdated
Comment thread content/developers/sdk/index.mdx
Comment thread content/developers/diy-keycard-shell.mdx Outdated
Comment thread content/developers/getting-started.mdx Outdated
Comment thread content/developers/github-repositories.mdx
Comment thread content/developers/hardware-specification.mdx Outdated
Comment thread content/developers/shell-api.mdx Outdated
Comment thread content/developers/shell-api.mdx Outdated
Comment thread content/developers/shell-wallet-integration.mdx Outdated
Comment thread content/developers/shell-wallet-integration.mdx
@github-project-automation github-project-automation Bot moved this from In Progress to ToDo in Web & User Interfaces Jul 13, 2026
- Fix QR account-export types: crypto-hdkey (ETH), crypto-account (BTC);
  mark crypto-multi-accounts/btc-sign-request/btc-signature as Keystone extensions
- Add shelljs library reference for wallet integrators
- Add Rust SDK (keycard-rs) to SDK and repositories pages
- Remove Cash applet from hardware spec (no longer installed)
- Remove stale version-pinned build instructions in DIY Shell
- Invert APDU overview paragraphs per reviewer request
- Replace Keycard Connect with CLI-first initialization path
- Add ecosystem-projects repo link
- Gitignore .env files

Co-Authored-By: Claude <noreply@anthropic.com>
bitgamma
bitgamma previously approved these changes Jul 13, 2026
@github-project-automation github-project-automation Bot moved this from ToDo to Waiting in Web & User Interfaces Jul 13, 2026
ShellJS wraps the Shell command set over a Ledger-style transport; it
does not handle UR encoding or QR codes. Moved from a standalone
'Supporting library' section into USB integration where it belongs.

Co-Authored-By: Claude <noreply@anthropic.com>
@guylouis
guylouis requested a review from Copilot July 13, 2026 09:33
@guylouis
guylouis marked this pull request as ready for review July 13, 2026 09:34
@guylouis
guylouis merged commit e49cf28 into main Jul 13, 2026
3 checks passed
@guylouis
guylouis deleted the improve/dev-docs branch July 13, 2026 09:34
@github-project-automation github-project-automation Bot moved this from Waiting to Done in Web & User Interfaces Jul 13, 2026

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Restructures the /developers documentation to be product-oriented (Keycard vs Keycard Shell), adds new integration/reference docs, and removes deprecated/redundant pages while keeping old URLs working via redirects.

Changes:

  • Rebuilds the developers sidebar/navigation into a product-separated structure with updated section naming.
  • Adds new Shell wallet-integration and Shell API reference pages; adds new “Contribute” content and expands repo/ecosystem mapping.
  • Removes deprecated pages (Web3 API, Tools, Contact, Shell internals) and introduces permanent redirects for legacy URLs.

Reviewed changes

Copilot reviewed 20 out of 25 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
src/config/developers.json Updates developers sidenav structure to product-separated sections and new pages.
next.config.mjs Adds permanent redirects for removed/renamed developer docs URLs.
content/help/faq.mdx Updates help-center links to point to new Shell integration/build docs.
content/help/about-keycard-and-keycard-shell.mdx Updates DIY Shell wording/link reference.
content/developers/web3.mdx Deletes deprecated Web3 API Extensions page.
content/developers/tools.mdx Deletes Tools page (content moved/redirected).
content/developers/shell-wallet-integration.mdx Adds new wallet-integration guide for Keycard Shell (QR + USB).
content/developers/shell-api.mdx Adds new Shell API reference (UR payloads, USB protocol, database, signing).
content/developers/sdk/index.mdx Rewrites SDK landing to a multi-SDK overview with a reference-SDK note.
content/developers/sdk/export.mdx Renames page title to “Exporting Keys” to match sidebar labeling.
content/developers/overview.mdx Major rewrite: new positioning, “choose your path”, and updated references.
content/developers/keycard-shell.mdx Deletes “Keycard Shell internals” page (superseded by new pages).
content/developers/hardware-specification.mdx Expands into a fuller spec sheet for Keycard + Shell, including certifications.
content/developers/github-repositories.mdx Rebuilds into “Ecosystem & Repositories” with tables + tool list.
content/developers/getting-started.mdx Updates getting-started flow; links card requirements to upstream README.
content/developers/diy-keycard-shell.mdx Renames/reframes DIY Shell page and updates references to new structure.
content/developers/contribute.mdx Adds a new contribution guide (issues, ABIs, integrations, hardware).
content/developers/contact.mdx Deletes Contact page (replaced by overview + contribute + redirects).
content/developers/build.mdx Renames “Build your Keycard” to “Build Your Own Keycard” and updates Shell link.
content/developers/apdu/overview.mdx Updates APDU overview intro to reference the renamed SDK docs and adds APDU explainer.
.gitignore Ignores .env* files.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment on lines +24 to +27
<TableRow>
<TableCell>Security certification</TableCell>
<TableCell>Common Criteria EAL6+ ([certificate](https://sec-certs.org/cc/f29f88756682e034/), [TÜV certification report](https://www.tuv-nederland.nl/assets/files/cerfiticaten/2022/09/nscib-cc-180212-cr5-1.0.pdf))</TableCell>
</TableRow>
# Overview

This document describes all APDUs part of the Keycard APDU protocol. Any implementation must fully implement this specification except for items explicitly marked as optional or conditional. The Keycard applet is a full implementation of this specification. The Java SDK provides both low-level methods to send each of the APDUs described here as well as convenience methods and classes to simplify integration.
This document describes all APDUs part of the Keycard protocol. Any implementation must fully implement this specification except for items explicitly marked as optional or conditional. The Keycard applet is a full implementation of this specification. The [Keycard SDK](/developers/sdk) provides both low-level methods to send each of the APDUs described here as well as convenience methods and classes to simplify integration.
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.

3 participants