Skip to content

refactor(docs): more conversions of sh to console for copy-paste #10666

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

vados-cosmonic
Copy link
Contributor

This commit udpates more instructions on various READMEs to avoid $ for easy copy-pasting, and also use console where appropriate.

@vados-cosmonic vados-cosmonic requested review from a team as code owners April 24, 2025 11:31
@vados-cosmonic vados-cosmonic requested review from fitzgen and removed request for a team April 24, 2025 11:31
@github-actions github-actions bot added cranelift Issues related to the Cranelift code generator fuzzing Issues related to our fuzzing infrastructure isle Related to the ISLE domain-specific language wasmtime:docs Issues related to Wasmtime's documentation labels Apr 24, 2025
Copy link

Subscribe to Label Action

cc @cfallin, @fitzgen

This issue or pull request has been labeled: "cranelift", "fuzzing", "isle", "wasmtime:docs"

Thus the following users have been cc'd because of the following labels:

  • cfallin: isle
  • fitzgen: fuzzing, isle

To subscribe or unsubscribe from this label, edit the .github/subscribe-to-label.json configuration file.

Learn more.

Copy link
Contributor

@dicej dicej left a comment

Choose a reason for hiding this comment

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

There are several blocks you've marked console which include $ prompts and/or command output (I've added inline comments for a few, but then got tired of repeating myself). I'm thinking those should all be marked shell-session given they can't be meaningfully cut-and-pasted, correct?

This commit udpates more instructions on various READMEs to avoid `$`
for easy copy-pasting, and also use `console` where appropriate.

Signed-off-by: Victor Adossi <vadossi@cosmonic.com>
@vados-cosmonic vados-cosmonic force-pushed the refactor(docs)=update-code-blocks branch from 74eefc8 to 4cbc146 Compare April 24, 2025 17:05
@vados-cosmonic vados-cosmonic requested a review from dicej April 24, 2025 17:06
@vados-cosmonic vados-cosmonic requested a review from dicej April 24, 2025 17:40
@vados-cosmonic
Copy link
Contributor Author

vados-cosmonic commented Apr 24, 2025

Thanks for the reviews @dicej ! Addressed the feedback 🙇

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cranelift Issues related to the Cranelift code generator fuzzing Issues related to our fuzzing infrastructure isle Related to the ISLE domain-specific language wasmtime:docs Issues related to Wasmtime's documentation
2 participants