Skip to content

Use shell blocks for readme - #118

Open
sipke wants to merge 5 commits into
OpenAMP:mainfrom
sipke:feature/use-shell-blocks-for-readme
Open

Use shell blocks for readme#118
sipke wants to merge 5 commits into
OpenAMP:mainfrom
sipke:feature/use-shell-blocks-for-readme

Conversation

@sipke

@sipke sipke commented Aug 31, 2026

Copy link
Copy Markdown

To address documentation issues
OpenAMP/openamp-docs#73
OpenAMP/openamp-docs#84
Update code blocks to not use prompt ($) on command line so that github and IDE copy button provides exact command line.

Sipke Vriend added 5 commits August 31, 2026 09:52
Remove the prompt $ symbol from console block command lines, so it is not
copied as well when using github or IDE copy button.

Signed-off-by: Sipke Vriend <sipke@direktembedded.com>
Split the zephyr console blocks into command line and output blocks to
allow the command line to be copied when using github or IDE.

Signed-off-by: Sipke Vriend <sipke@direktembedded.com>
Use the markdown shell block so that users can copy the block, or
execute lines as supported by IDEs.

Signed-off-by: Sipke Vriend <sipke@direktembedded.com>
To allow for formatting of readme rename to README.md

Signed-off-by: Sipke Vriend <sipke@direktembedded.com>
…ding

Use a code block for the udev rules and extend the heading underline
for eptdestroy.

Signed-off-by: Sipke Vriend <sipke@direktembedded.com>

@arnopo arnopo left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

LGTM

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