Skip to content

Commit 17d5477

Browse files
authored
Merge pull request #341 from mkaszewiak/updateOverviewFile
updated and sorted overview lists
2 parents f1f74eb + 7f810ea commit 17d5477

File tree

4 files changed

+48
-25
lines changed

4 files changed

+48
-25
lines changed

docs/presentation/overview.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,12 @@ This section provides how-to topics for working with presentation documents usin
2020

2121
## In this section
2222

23-
- [Structure of a PresentationML document](structure-of-a-presentationml-document.md)
23+
- [Structure of a PresentationML document](structure-of-a-presentationml-document.md)
2424

25-
- [Add a comment to a slide in a presentation](how-to-add-a-comment-to-a-slide-in-a-presentation.md)
26-
27-
- [Add a video to a slide in a presentation](how-to-add-a-video-to-a-slide-in-a-presentation.md)
25+
26+
- [Add an audio file to a slide in a presentation](how-to-add-an-audio-to-a-slide-in-a-presentation.md)
27+
28+
- [Add a comment to a slide in a presentation](how-to-add-a-comment-to-a-slide-in-a-presentation.md)
2829

2930
- [Apply a theme to a presentation](how-to-apply-a-theme-to-a-presentation.md)
3031

@@ -42,7 +43,7 @@ This section provides how-to topics for working with presentation documents usin
4243

4344
- [Get all the text in all slides in a presentation](how-to-get-all-the-text-in-all-slides-in-a-presentation.md)
4445

45-
- [Get the titles of all the slides in a presentation](how-to-get-the-titles-of-all-the-slides-in-a-presentation.md)
46+
- [Get the titles of all the slides in a presentation](how-to-get-the-titles-of-all-the-slides-in-a-presentation.md)
4647

4748
- [Insert a new slide into a presentation](how-to-insert-a-new-slide-into-a-presentation.md)
4849

@@ -52,7 +53,7 @@ This section provides how-to topics for working with presentation documents usin
5253

5354
- [Open a presentation document for read-only access](how-to-open-a-presentation-document-for-read-only-access.md)
5455

55-
- [Retrieve the number of slides in a presentation document](how-to-retrieve-the-number-of-slides-in-a-presentation-document.md)
56+
- [Retrieve the number of slides in a presentation document](how-to-retrieve-the-number-of-slides-in-a-presentation-document.md)
5657

5758
- [Working with animation](working-with-animation.md)
5859

docs/spreadsheet/overview.md

Lines changed: 18 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -23,22 +23,12 @@ This section provides how-to topics for working with spreadsheet documents using
2323

2424
- [Structure of a SpreadsheetML document](structure-of-a-spreadsheetml-document.md)
2525

26-
- [Working with the calculation chain](working-with-the-calculation-chain.md)
27-
28-
- [Working with conditional formatting](working-with-conditional-formatting.md)
29-
30-
- [Working with formulas](working-with-formulas.md)
31-
32-
- [Working with PivotTables](working-with-pivottables.md)
33-
34-
- [Working with the shared string table](working-with-the-shared-string-table.md)
35-
36-
- [Working with sheets](working-with-sheets.md)
37-
38-
- [Working with SpreadsheetML tables](working-with-tables.md)
26+
- [Add custom UI to a spreadsheet document](how-to-add-custom-ui-to-a-spreadsheet-document.md)
3927

4028
- [Calculate the sum of a range of cells in a spreadsheet document](how-to-calculate-the-sum-of-a-range-of-cells-in-a-spreadsheet-document.md)
4129

30+
- [Copy a Worksheet Using SAX (Simple API for XML)](how-to-copy-a-worksheet-with-sax.md)
31+
4232
- [Create a spreadsheet document by providing a file name](how-to-create-a-spreadsheet-document-by-providing-a-file-name.md)
4333

4434
- [Delete text from a cell in a spreadsheet document](how-to-delete-text-from-a-cell-in-a-spreadsheet.md)
@@ -69,6 +59,21 @@ This section provides how-to topics for working with spreadsheet documents using
6959

7060
- [Retrieve the values of cells in a spreadsheet document](how-to-retrieve-the-values-of-cells-in-a-spreadsheet.md)
7161

62+
- [Retrieve a list of the worksheets in a spreadsheet document](how-to-retrieve-a-list-of-the-worksheets-in-a-spreadsheet.md)
63+
64+
- [Working with the calculation chain](working-with-the-calculation-chain.md)
65+
66+
- [Working with conditional formatting](working-with-conditional-formatting.md)
67+
68+
- [Working with formulas](working-with-formulas.md)
69+
70+
- [Working with PivotTables](working-with-pivottables.md)
71+
72+
- [Working with the shared string table](working-with-the-shared-string-table.md)
73+
74+
- [Working with sheets](working-with-sheets.md)
75+
76+
- [Working with SpreadsheetML tables](working-with-tables.md)
7277

7378
## Related sections
7479

docs/word/overview.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,8 @@ This section provides how-to topics for working with word processing documents u
2121

2222
## In this section
2323

24+
- [Structure of a WordprocessingML document](structure-of-a-wordprocessingml-document.md)
25+
2426
- [Accept all revisions in a word processing document](how-to-accept-all-revisions-in-a-word-processing-document.md)
2527

2628
- [Add tables to word processing documents](how-to-add-tables-to-word-processing-documents.md)
@@ -59,13 +61,15 @@ This section provides how-to topics for working with word processing documents u
5961

6062
- [Remove the headers and footers from a word processing document](how-to-remove-the-headers-and-footers-from-a-word-processing-document.md)
6163

64+
- [How to: Replace Text in a Word Document Using SAX (Simple API for XML)](how-to-replace-text-in-a-word-document-with-sax.md)
65+
6266
- [Replace the header in a word processing document](how-to-replace-the-header-in-a-word-processing-document.md)
6367

64-
- [Replace the styles parts in a word processing document](how-to-replace-the-styles-parts-in-a-word-processing-document.md)
68+
- [Replace the styles parts in a word processing document](how-to-replace-the-styles-parts-in-a-word-processing-document.md)
6569

66-
- [Retrieve comments from a word processing document](how-to-retrieve-comments-from-a-word-processing-document.md)
70+
- [Retrieve application property values from a Word document by using the Open XML API](how-to-retrieve-application-property-values-from-a-word-processing-document.md)
6771

68-
- [Retrieve property values from a Word document by using the Open XML API](how-to-retrieve-application-property-values-from-a-word-processing-document.md)
72+
- [Retrieve comments from a word processing document](how-to-retrieve-comments-from-a-word-processing-document.md)
6973

7074
- [Set a custom property in a word processing document](how-to-set-a-custom-property-in-a-word-processing-document.md)
7175

@@ -78,8 +82,7 @@ This section provides how-to topics for working with word processing documents u
7882
- [Working with runs](working-with-runs.md)
7983

8084
- [Working with WordprocessingML tables](working-with-wordprocessingml-tables.md)
81-
82-
- [Structure of a WordprocessingML document](structure-of-a-wordprocessingml-document.md)
85+
8386

8487
## Related sections
8588

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)