Skip to content

Commit 224a2da

Browse files
committed
Fix H3 and reorder sections
1 parent 0fad058 commit 224a2da

1 file changed

Lines changed: 27 additions & 36 deletions

File tree

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

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

1111
Welcome to the PowerShell online documentation.
1212

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

1515
The web page contains multiple elements that help you use and navigate the documentation.
1616

17+
![Screenshot showing the various elements of the web page.][02]
18+
1719
### Navigation elements
1820

1921
- **Site level navigation** - The site level navigation appears at the top of the page. It contains
@@ -51,7 +53,7 @@ These buttons provide other ways of interacting with the content.
5153
- The **Menu** button provides a way to add content to a collection, provide feedback, edit the
5254
content, or share the content with others.
5355

54-
### Feedback
56+
### Feedback elements
5557

5658
There are two ways to provide feedback on the documentation.
5759

@@ -61,6 +63,28 @@ There are two ways to provide feedback on the documentation.
6163
documentation or the product. These links take you to the GitHub repository where you can open an
6264
issue and give feedback.
6365

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

6690
This site contains cmdlet reference for the following versions of PowerShell:
@@ -105,40 +129,7 @@ Major Minor Build Revision
105129
5 1 26100 7705
106130
```
107131

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

143134
Documentation for older versions of PowerShell is archived in our [Previous Versions][01] site. You
144135
can choose **Previous Versions** from the version selector.

0 commit comments

Comments
 (0)