Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use text instead of bash for CLI docs #5977

Merged
merged 1 commit into from
Jan 9, 2024
Merged

Conversation

pawurb
Copy link
Contributor

@pawurb pawurb commented Jan 8, 2024

Currently CLI docs have a visual bug that affects readability. Because of bash syntax random words are highlighted and ' character causes text to suddenly change color (example):

Screenshot 2024-01-08 at 21 42 20

This PR uses text to disable random highlighting and improve readability. Before:

before

after:

after

@pawurb pawurb requested a review from gakonst as a code owner January 8, 2024 20:55
Copy link
Collaborator

@mattsse mattsse left a comment

Choose a reason for hiding this comment

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

reasonable, ty

@mattsse mattsse added this pull request to the merge queue Jan 9, 2024
@mattsse mattsse added the C-docs An addition or correction to our documentation label Jan 9, 2024
Merged via the queue into paradigmxyz:main with commit d421120 Jan 9, 2024
27 checks passed
@pawurb pawurb deleted the docs_syntax branch January 9, 2024 17:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-docs An addition or correction to our documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants