Skip to content

Commit 6f1d31e

Browse files
committed
fix(doc): styling updates
1 parent de521fe commit 6f1d31e

File tree

6 files changed

+8
-8
lines changed

6 files changed

+8
-8
lines changed

archetypes/learning-path/_next-steps.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
# ================================================================================
33
# FIXED, DO NOT MODIFY THIS FILE
44
# ================================================================================
5-
weight: 21 # Set to always be larger than the content in this path to be at the end of the navigation.
5+
weight: 21 # The weight controls the order of the pages. _index.md always has weight 1.
66
title: "Next Steps" # Always the same, html page title.
77
layout: "learningpathall" # All files under learning paths have this same wrapper for Hugo processing.
88
---

content/learning-paths/cross-platform/_example-learning-path/_next-steps.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
# ================================================================================
33
# FIXED, DO NOT MODIFY THIS FILE
44
# ================================================================================
5-
weight: 21 # Set to always be larger than the content in this path to be at the end of the navigation.
5+
weight: 21 # The weight controls the order of the pages. _index.md always has weight 1.
66
title: "Next Steps" # Always the same, html page title.
77
layout: "learningpathall" # All files under learning paths have this same wrapper for Hugo processing.
88
---

content/learning-paths/cross-platform/_example-learning-path/appendix-2-writing-style.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Recommended:
3131
 
3232
 
3333

34-
## Keep It Short and Simple
34+
## Keep It Short and Simple (KISS Principle)
3535

3636
Use short words, sentences, paragraphs and sections. Avoid a long or complex word when a simpler, shorter word will make the same point. Conditional words are ambiguous. For example, instead of “could”, “would”, “should”, and “may”, use “can”, “will”, and “might”.
3737

content/learning-paths/cross-platform/_example-learning-path/contribute.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ If you are new to GitHub, please go to [GitHub's documentation](https://docs.git
5959
to learn how to create a pull request from a GitHub fork.
6060
{{% /notice %}}
6161

62-
Optionally, if you would like to add your new Learning Path content to the automated testing framework, follow the guidelines in the [Appendix: How to test your code](/learning-paths/cross-platform/_example-learning-path/appendix-3-test).
62+
Optionally, if you would like to add your new Learning Path content to the automated testing framework, for testing instructions and code snippets automatically in the learning path, follow the guidelines in the [Appendix: How to test your code](/learning-paths/cross-platform/_example-learning-path/appendix-3-test).
6363

6464
## Publishing
6565

content/learning-paths/cross-platform/_example-learning-path/write-1-init.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ To add a new Learning Path, first decide the appropriate category. There are 6 c
2222
Place your Learning Path in the category closest to the environment where the software runs. The tags on the [front page of the website](/) help explain the categories. Feel free to ask on GitHub if you are unsure which category best matches your Learning Path.
2323
{{% /notice %}}
2424

25-
You can also add a new install guide. Install guides are short descriptions providing commonly used information to install tools and software. Install guides are easy to reference from multiple Learning Paths and avoid repetition.
25+
You can also add a new install guide. Install guides are short descriptions providing commonly used information to install tools and software. Install guides are easy to reference from multiple Learning Paths and avoid repetition. Upcoming section will provide details to create a new install guide. Refer to the [existing install guides](https://learn.arm.com/install-guides) to see what is available.
2626

2727
### Create a new Learning Path
2828

@@ -37,7 +37,7 @@ Result: The following markdown files are added to the `my-new-learning-path` dir
3737

3838
| Files | Details |
3939
|--------------- |----------|
40-
| _index.md | This file contains the title, target audience, and tagging metadata for your new Learning Path. The next step of this Learning Path explains these metadata elements and how to complete them correctly. |
40+
| _index.md | This file contains the title, target audience, and tagging metadata for your new Learning Path. These are displayed when clicking on the `Introduction` section in the vertical menu on the left. The next step of this Learning Path explains these metadata elements and how to complete them correctly.|
4141
| how-to-1.md | This file contains the how-to content for the Learning Path. Create multiple how-to pages to segment stages within your Learning Path. Each `how-to-N.md` file represents another distinct stage in your learning Path. Name this file to reflect the content you are adding. |
4242
| example-picture.png | (optional) Pictures and screenshots can be included in this directory to appear in your Learning Path, Images can also be referenced as web links if you prefer. |
4343
| _next_steps.md | DO NOT edit this file, it acts as a static placeholder only. |
@@ -74,7 +74,7 @@ If Hugo is not already running start it.
7474
hugo server
7575
```
7676

77-
2. View the Learning Path you just created in your browser by opening [http://localhost:1313/learning-paths/servers-and-cloud-computing/my-new-learning-path](http://localhost:1313/learning-paths/servers-and-cloud-computing/my-new-learning-path)
77+
2. View the Learning Path you just created in your browser by opening [http://localhost:1313/learning-paths/embedded-and-microcontrollers/my-new-learning-path](http://localhost:1313/learning-paths/embedded-and-microcontrollers/my-new-learning-path)
7878

7979
3. Refer to the appendix listed below for content formatting and style guidance
8080

content/learning-paths/cross-platform/_example-learning-path/write-2-metadata.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ Specifies the tools, softwares, or languages this Learning Path uses. Please lis
114114
| Libraries | zlib, snappy |
115115

116116

117-
### arm_ips (open)
117+
### armips (open)
118118

119119
Specifies the Arm IP this Learning Path involves, providing a quick link to IP information for developers interested in learning more. You can enter multiple specific or groups of IP. Note that this is not used for filtering content, but is clickable for readers to find more information about these IPs through searching automatically on developer.arm.com.
120120

0 commit comments

Comments
 (0)