Skip to content

Commit 661578e

Browse files
committed
Fix H3 and reorder sections
1 parent 8cb0715 commit 661578e

File tree

1 file changed

+38
-36
lines changed

1 file changed

+38
-36
lines changed

reference/docs-conceptual/how-to-use-docs.md

Lines changed: 38 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,12 @@ title: How to use the PowerShell documentation
88

99
Welcome to the PowerShell online documentation.
1010

11-
![Screenshot showing the various elements of the web page.][02]
11+
## Features of the Learn platform
1212

1313
The web page contains multiple elements that help you use and navigate the documentation.
1414

15+
![Screenshot showing the various elements of the web page.][02]
16+
1517
### Navigation elements
1618

1719
- **Site level navigation** - The site level navigation appears at the top of the page. It contains
@@ -44,7 +46,7 @@ These buttons provide other ways of interacting with the content.
4446
- The **Menu** button provides a way to add content to a collection, provide feedback, edit the
4547
content, or share the content with others.
4648

47-
### Feedback
49+
### Feedback elements
4850

4951
There are two ways to provide feedback on the documentation.
5052

@@ -54,6 +56,28 @@ There are two ways to provide feedback on the documentation.
5456
documentation or the product. These links take you to the GitHub repository where you can open an
5557
issue and give feedback.
5658

59+
## Filter and search for articles
60+
61+
There are two ways to search for content in Docs.
62+
63+
- The filter and search box under the version selector allows filtering articles by words that
64+
appear in the title of an article or command aliases. The filter displays a list of matching
65+
articles as you type. You can also select the option to search for the words in the body of
66+
articles. When you search from here, the search is limited to the PowerShell documentation.
67+
- The search box in the site-level navigation bar searches the entire site. It returns a list of
68+
matching articles from all documentation sets.
69+
70+
In the following example, you see how the drop-down list is filtered to show the `Get-ChildItem`
71+
command as you type the name. When you enter `gci`, the filter shows the `Get-CimInstance` and
72+
`Get-ChildItem` commands because the alias for both commands starts with `gci`.
73+
74+
Next, the word `idempotent` is entered. The filter shows no articles. Clicking the search link
75+
searches for `idempotent` in the PowerShell documentation. This search only returns 12 results.
76+
Notice the difference when the same word is searched using the site-level search box. The search
77+
returns 1,096 articles from the entire Microsoft Learn site.
78+
79+
![Animation showing how to use the search features.][05]
80+
5781
## Selecting the version of PowerShell
5882

5983
This site contains cmdlet reference for the following versions of PowerShell:
@@ -88,40 +112,7 @@ Major Minor Build Revision
88112
5 1 26100 7705
89113
```
90114

91-
## Filter and search for articles
92-
93-
There are two ways to search for content in Docs.
94-
95-
- The filter and search box under the version selector allows filtering articles by words that
96-
appear in the title of an article or command aliases. The filter displays a list of matching
97-
articles as you type. You can also select the option to search for the words in the body of
98-
articles. When you search from here, the search is limited to the PowerShell documentation.
99-
- The search box in the site-level navigation bar searches the entire site. It returns a list of
100-
matching articles from all documentation sets.
101-
102-
In the following example, you see how the drop-down list is filtered to show the `Get-ChildItem`
103-
command as you type the name. When you enter `gci`, the filter shows the `Get-CimInstance` and
104-
`Get-ChildItem` commands because the alias for both commands starts with `gci`.
105-
106-
Next, the word `idempotent` is entered. The filter shows no articles. Clicking the search link
107-
searches for `idempotent` in the PowerShell documentation. This search only returns 12 results.
108-
Notice the difference when the same word is searched using the site-level search box. The search
109-
returns 1,096 articles from the entire Microsoft Learn site.
110-
111-
![Animation showing how to use the search features.][05]
112-
113-
## Download the documentation as a PDF
114-
115-
To download the documentation as a PDF, select the **Download PDF** button at the bottom of the TOC.
116-
117-
![Screenshot of the Download PDF button.][03]
118-
119-
- If you're viewing a conceptual article, the Learn platform creates a PDF containing the conceptual
120-
content for the selected version.
121-
- If you're viewing a reference article, the Learn platform creates a PDF containing the reference
122-
content for the selected version.
123-
124-
## Find articles for older versions of PowerShell
115+
### Find articles for older versions of PowerShell
125116

126117
Documentation for older versions of PowerShell is archived in our [Previous Versions][01] site. You
127118
can choose **Previous Versions** from the version selector.
@@ -144,6 +135,17 @@ unsupported versions of PowerShell:
144135
- PowerShell 4.0
145136
- PowerShell 3.0
146137

138+
## Download the documentation as a PDF
139+
140+
To download the documentation as a PDF, select the **Download PDF** button at the bottom of the TOC.
141+
142+
![Screenshot of the Download PDF button.][03]
143+
144+
- If you're viewing a conceptual article, the Learn platform creates a PDF containing the conceptual
145+
content for the selected version.
146+
- If you're viewing a reference article, the Learn platform creates a PDF containing the reference
147+
content for the selected version.
148+
147149
<!-- link references -->
148150
[01]: https://aka.ms/PSLegacyDocs
149151
[02]: media/how-to-use-docs/how-to-use.gif

0 commit comments

Comments
 (0)