Skip to content

πŸ“ (doc) [NO-ISSUE]: Doc format#1322

Open
cfranceschi-ledger wants to merge 1 commit intodevelopfrom
doc/no-issue-format
Open

πŸ“ (doc) [NO-ISSUE]: Doc format#1322
cfranceschi-ledger wants to merge 1 commit intodevelopfrom
doc/no-issue-format

Conversation

@cfranceschi-ledger
Copy link
Collaborator

πŸ“ Description

  • I added front matter in formation: we use it to classify doc type
  • I transformed "clear signing" in "Clear Signing" as it is the correct format

❓ Context

[NO-ISSUE]

βœ… Checklist

Not applicable, only documentation was modified.


🧐 Checklist for the PR Reviewers

  • The code aligns with the requirements described in the linked JIRA or GitHub issue.
  • The PR description clearly documents the changes made and explains any technical trade-offs or design decisions.
  • There are no undocumented trade-offs, technical debt, or maintainability issues.
  • The PR has been tested thoroughly, and any potential edge cases have been considered and handled.
  • Any new dependencies have been justified and documented.

Added front matter in formation + Clear Signing correct format
Copilot AI review requested due to automatic review settings February 18, 2026 08:05
@cfranceschi-ledger cfranceschi-ledger requested a review from a team as a code owner February 18, 2026 08:05
@vercel
Copy link

vercel bot commented Feb 18, 2026

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

Project Deployment Actions Updated (UTC)
device-sdk-ts-sample Ready Ready Preview, Comment Feb 18, 2026 8:05am
1 Skipped Deployment
Project Deployment Actions Updated (UTC)
doc-device-management-kit Ignored Ignored Feb 18, 2026 8:05am

Request Review

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

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.

@github-actions
Copy link
Contributor

Danger Check Results

Messages

⚠️

No changeset file found. Please make sure this is intended or add a changeset file.

βœ…

Danger: All checks passed successfully! πŸŽ‰

Generated by 🚫 dangerJS against bd0821f

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