Skip to content

Markdown formatting#21

Merged
yanjieniu merged 3 commits intomainfrom
markdown-formatting
Sep 11, 2025
Merged

Markdown formatting#21
yanjieniu merged 3 commits intomainfrom
markdown-formatting

Conversation

@mwunderl
Copy link
Copy Markdown
Contributor

Issue #, if available: #19

Description of changes: Address tilde and quote usage issues in markdown tutorial files and instructions.

prompts used

several of the markdown files in this directory's folders contain tilde ~ characters . Sometimes they mean "about" in which case they should be replaced with the word they represent, and in other cases they are in code examples where they can mean "home" in linux. There may be other uses. In code examples the code block or inline code should be properly formatted, otherwise multiple tildes on the same line will cause the markdown file to render the text between the tilde characters as strikethrough. Review all of the markdown files and make any fixes needed. Check your own work and escalate to me as needed.

review all of the markdown files to ensure that inline commands, code, filepaths are formatted as code with backticks and not using double quotes. remove any redundant quotes.

some files still have code blocks with backticks with extra double quotes around them. audit all inline double quotes

update the agent instructions in ../instra/tutorial-gen steps 3b and 4 to ensure that the tutorials properly use backticks and tildes for new tutorials

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@mwunderl mwunderl requested a review from yanjieniu September 10, 2025 21:58
@yanjieniu yanjieniu merged commit 4aa8d01 into main Sep 11, 2025
3 checks passed
@yanjieniu yanjieniu self-assigned this Sep 11, 2025
Copy link
Copy Markdown
Contributor

@yanjieniu yanjieniu left a comment

Choose a reason for hiding this comment

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

Looks good. Approve.

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