Skip to content

Commit 5b3abb8

Browse files
committed
added instructions to update toc and overview
1 parent d1f321c commit 5b3abb8

File tree

1 file changed

+15
-1
lines changed

1 file changed

+15
-1
lines changed

samples/README.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,27 @@ To add a sample, run the the following:
1010

1111
This will create an initial scaffold for a sample and add it to the solution file.
1212

13+
## Steps to Complete Before Creating a Pull Request:
14+
1. **Test Both Code Samples**
15+
Verify the functionality of both the C# and Visual Basic samples. To accelerate the process, you can use Copilot to translate the C# sample into Visual Basic. When writing code samples, avoid using var; instead, explicitly declare variable types.
16+
17+
2. **Validate Documentation with DocFX**
18+
Use the https://dotnet.github.io/docfx/ to ensure the generated documentation renders correctly and behaves as expected.
19+
20+
3. **Update the Table of Contents**
21+
Add a new entry to the toc.yml file so the content appears in the Navigation Pane on the Microsoft Learn website.
22+
23+
4. **Edit the Overview Page**
24+
Update the overview.md file with the new title and markdown file reference to ensure it appears in the overview section on Microsoft Learn. This file is located in one of the following directories: docs/presentation, docs/spreadsheet, or docs/word.
25+
26+
1327
## Migrate old samples
1428

1529
```powershell
1630
./migrate-sample.ps1 path-to-md-file
1731
```
1832

19-
This will do an inital extraction and clean up of the file, as well as add the code to the solution. Additional clean up will be necessary, but should be minimal.
33+
This will do an initial extraction and clean up of the file, as well as add the code to the solution. Additional clean up will be necessary, but should be minimal.
2034

2135
General changes to move a sample:
2236

0 commit comments

Comments
 (0)