Skip to content

Commit 0e57467

Browse files
committed
formatting instructions
1 parent 6664a01 commit 0e57467

2 files changed

Lines changed: 38 additions & 3 deletions

File tree

instra/tutorial-gen/3b-validate-tutorial.md

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,26 @@
11
# validate tutorial
22

33
Validating the content of the AWS CLI tutorial and surface issues about the generated content.
4+
## formatting and style
5+
6+
Review the tutorial markdown for proper formatting:
7+
8+
**Backticks usage:**
9+
- Use backticks for all inline code, commands, file paths, resource IDs, status values, and technical terms
10+
- Examples: `aws s3 ls`, `my-bucket-name`, `ACTIVE`, `~/path/to/file`, `us-east-1`
11+
- Never use double quotes around backticked content (avoid `"~/file"`, use `~/file`)
12+
13+
**Tilde usage:**
14+
- Use tildes (`~`) only in code blocks to represent home directory paths
15+
- Replace tildes meaning "approximately" with the word "approximately"
16+
- Examples: "approximately $0.50/hour" not "~$0.50/hour"
17+
18+
**Quotes usage:**
19+
- Avoid double quotes around technical terms, file names, or commands in descriptive text
20+
- Use backticks instead: `filename.txt` not "filename.txt"
21+
- Keep quotes only for actual quoted speech or JSON string values in code blocks
22+
23+
Document any formatting issues in 3-formatting.md.
424

525
## deprecated features
626

@@ -24,4 +44,4 @@ Check the tutorial for issues from an application architecure standpoint. Consid
2444

2545
## improvements over baseline
2646

27-
Review the baseline tutorial for errors and omissions that were fixed by following the authoring instructions, or caught by validation. Note any issues in 3-baseline.md.
47+
Review the baseline tutorial for errors and omissions that were fixed by following the authoring instructions, or caught by validation. Note any issues in 3-baseline.md.

instra/tutorial-gen/4-address-feedback.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,22 @@
11
# address feedback
22

33
Review the instructions for creating a tutorial, and the test results from previous steps. Address issues that arose during testing, as long as they are valid and don't contradict your instructions.
4-
4+
## formatting and style
5+
6+
If the previous step identified any formatting issues, fix them:
7+
8+
**Backticks corrections:**
9+
- Replace double quotes around technical terms with backticks
10+
- Remove redundant quotes around backticked content
11+
- Ensure all commands, file paths, resource IDs, and status values use backticks
12+
13+
**Tilde corrections:**
14+
- Replace tildes meaning "approximately" with the word "approximately"
15+
- Ensure tildes are only used in code blocks for home directory paths
16+
17+
**Quote corrections:**
18+
- Remove unnecessary double quotes around technical terms in descriptive text
19+
- Maintain quotes only for actual quoted content or JSON strings in code blocks
520
## deprecated features
621

722
If the previous step identified any deprecated features, revise the scripts and tutorial to use recommended features that provide the same functionality. If there isn't a newer feature available that provides the same functionality, remove the steps that use the deprecated feature. If the tutorial can't be completed without these steps, generate an error report and ask the user what to do next.
@@ -16,4 +31,4 @@ If the previous step identified any issues with security or architecture best pr
1631

1732
## readme
1833

19-
Generate a readme file that provides a high level overview of the tutorial and a list of the resources within.
34+
Generate a readme file that provides a high level overview of the tutorial and a list of the resources within.

0 commit comments

Comments
 (0)