Skip to content

docs: fix markdown pipe escaping in installation commands#8

Open
Mohit-001-hash wants to merge 1 commit into
zero-gate-org:mainfrom
Mohit-001-hash:fix-installation-pipe-escaping
Open

docs: fix markdown pipe escaping in installation commands#8
Mohit-001-hash wants to merge 1 commit into
zero-gate-org:mainfrom
Mohit-001-hash:fix-installation-pipe-escaping

Conversation

@Mohit-001-hash

Copy link
Copy Markdown

Description

  • What changed: Removed the unnecessary backslash escapes (\) from the curl pipe commands in the "Requirements" table of the README.md[cite: 4].
  • Why it changed: Including backslashes in these Markdown code blocks can cause the installation commands to fail when users copy and paste them into their terminal, as the shell interprets the backslash literally rather than as a pipe operator[cite: 4].

Related Issue

Closes #None

Type of Change

  • Bug fix (non-breaking change that fixes an issue)
  • New feature (non-breaking change that adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update
  • Code refactor (no functional changes)
  • Performance improvement
  • Test update

How Has This Been Tested?

  • Manual Verification: Verified that the corrected curl commands in the Markdown table match the standard installation patterns provided by the official Rust and Bun documentation[cite: 4].

Test Environment:

  • OS: Cross-platform (macOS/Linux)
  • Node version: N/A
  • Browser (if applicable): N/A

Screenshots (if applicable)

N/A (Documentation update only)

Checklist

  • My code follows the coding standards of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings or errors
  • I have added tests that prove my fix/feature works
  • All existing tests pass locally

Additional Notes

Ensuring that installation commands are copy-paste ready is crucial for reducing friction for new contributors attempting to build Knowte from source[cite: 4].

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