π (doc) [NO-ISSUE]: Doc format#1322
Open
cfranceschi-ledger wants to merge 1 commit intodevelopfrom
Open
Conversation
Added front matter in formation + Clear Signing correct format
|
The latest updates on your projects. Learn more about Vercel for GitHub.
1 Skipped Deployment
|
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds YAML front matter metadata to documentation files and standardizes the capitalization of "Clear Signing" as a proper noun throughout the documentation. The front matter includes title and category fields used for document classification and organization.
Changes:
- Added front matter (title and category fields) to 20 MDX documentation files
- Updated "clear signing" to "Clear Signing" in 3 locations to reflect proper capitalization of the Ledger feature name
Reviewed changes
Copilot reviewed 23 out of 23 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| apps/docs/pages/docs/references/ts-doc.mdx | Added front matter with title "TS Doc" and category "reference" |
| apps/docs/pages/docs/references/signers/solana.mdx | Added front matter and capitalized "Clear Signing" in 2 locations |
| apps/docs/pages/docs/references/signers/eth.mdx | Added front matter and capitalized "Clear Signing" in 1 location |
| apps/docs/pages/docs/references/signers/btc.mdx | Added front matter with title "Bitcoin Signer Kit" and category "reference" |
| apps/docs/pages/docs/references/identifiers.mdx | Added front matter with title "Device and Transport Identifiers" and category "reference" |
| apps/docs/pages/docs/references/device-management-kit/secure-channel.mdx | Added front matter with title "Secure Channel" and category "reference" |
| apps/docs/pages/docs/integration/migrations/signers/eth/1_3_3_to_1_4_0.mdx | Added front matter with title "Migration from 1.3.3 to 1.4.0" and category "how-to" |
| apps/docs/pages/docs/integration/migrations/signers/eth/1_1_0_to_1_2_0.mdx | Added front matter with title "Migration from 1.1.0 to 1.2.0" and category "how-to" |
| apps/docs/pages/docs/integration/migrations/dmk/0_6_1_to_0_6_2.mdx | Added front matter with title "Migration from 0.6.1 to 0.6.2" and category "how-to" |
| apps/docs/pages/docs/integration/migrations/dmk/05_to_06.mdx | Added front matter with title "Migration from 0.5.0 to 0.6.0" and category "how-to" |
| apps/docs/pages/docs/integration/how_to/transports.mdx | Added front matter with title "Transports" and category "how-to" |
| apps/docs/pages/docs/integration/how_to/how_to_use_a_signer.mdx | Added front matter with title "Use a signer" and category "how-to" |
| apps/docs/pages/docs/integration/how_to/dmk.mdx | Added front matter with title "Device Management Kit" and category "how-to" |
| apps/docs/pages/docs/integration/how_to/build_custom_command.mdx | Added front matter with title "Build a Custom Command" and category "how-to" |
| apps/docs/pages/docs/getting-started.mdx | Added front matter with title "Documentation" and category "overview" |
| apps/docs/pages/docs/explanation/signers.mdx | Added front matter with title "Understanding Device Signer Kits" and category "explanation" |
| apps/docs/pages/docs/explanation/ledgerjs.mdx | Added front matter with title "Differences with LedgerJS" and category "explanation" |
| apps/docs/pages/docs/explanation/introduction.mdx | Added front matter with title "Why choose the Device Management Kit?" and category "explanation" |
| apps/docs/pages/docs/beginner/setup.mdx | Added front matter with title "Setup" and category "tutorial" |
| apps/docs/pages/docs/beginner/init_dmk.mdx | Added front matter with title "Initializing and Configuring the DMK" and category "tutorial" |
| apps/docs/pages/docs/beginner/exchange_data.mdx | Added front matter with title "Exchange data with the device" and category "tutorial" |
| apps/docs/pages/docs/beginner/discover_and_connect.mdx | Added front matter with title "Connecting to a Device" and category "tutorial" |
| apps/docs/pages/docs/beginner/ble_flex_stax.mdx | Added front matter with title "Add BLE and USB support for Flex and Stax" and category "tutorial" |
π‘ Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Contributor
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.
π Description
β Context
[NO-ISSUE]
β Checklist
Not applicable, only documentation was modified.
π§ Checklist for the PR Reviewers