Skip to content

Conversation

@jadonamite
Copy link

Fixed critical formatting issues in the Sign SDK overview documentation (overview.mdx) that made installation instructions difficult to read and copy:

Main Issues Fixed:

  1. Malformed CodeGroup blocks: Restructured collapsed package manager installation commands in the Web tab that were improperly formatted on single lines, making them unreadable and unusable
  2. Node.js installation section: Fixed the same formatting issue in the lokijs installation CodeGroup
  3. Improved code formatting: Cleaned up indentation and spacing throughout all platform-specific installation sections for better readability

Impact:

  • Users can now properly copy and paste installation commands for npm, yarn, bun, and pnpm
  • Installation instructions are now clear and accessible across all supported platforms
  • Improved overall documentation quality and user experience

Tests

  • - Ran the changes locally with Mintlify and confirmed that the changes appear as expected.
  • - Ran a grammar check on the updated/created content using ChatGPT.
  • - Verified all code blocks render correctly with proper syntax highlighting
  • - Confirmed installation commands are properly separated and copyable

Direct link to the deployed preview files

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.

1 participant