Skip to content

Elide manual table of contents #5338

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged

Conversation

Rageking8
Copy link
Contributor

Elide all manual table of contents as they are superfluous, as seen in the following:

image

Copy link
Contributor

@Rageking8 : Thanks for your contribution! The author(s) and reviewer(s) have been notified to review your proposed change.

Copy link
Contributor

Learn Build status updates of commit 03454d9:

✅ Validation status: passed

File Status Preview URL Details
docs/parallel/amp/reference/concurrency-graphics-namespace-functions.md ✅Succeeded
docs/parallel/amp/reference/concurrency-namespace-constants-amp.md ✅Succeeded
docs/parallel/amp/reference/concurrency-namespace-enums-amp.md ✅Succeeded
docs/parallel/openmp/c-openmp-c-and-cpp-grammar.md ✅Succeeded
docs/standard-library/atomic-functions.md ✅Succeeded
docs/standard-library/fstream-typedefs.md ✅Succeeded
docs/standard-library/future-enums.md ✅Succeeded
docs/standard-library/future-functions.md ✅Succeeded
docs/standard-library/hash-map-functions.md ✅Succeeded
docs/standard-library/hash-map-operators.md ✅Succeeded
docs/standard-library/hash-set-functions.md ✅Succeeded
docs/standard-library/hash-set-operators.md ✅Succeeded
docs/standard-library/iomanip-functions.md ✅Succeeded
docs/standard-library/istream-functions.md ✅Succeeded
docs/standard-library/istream-typedefs.md ✅Succeeded
docs/standard-library/locale-functions.md ✅Succeeded
docs/standard-library/ostream-operators.md ✅Succeeded
docs/standard-library/ostream-typedefs.md ✅Succeeded
docs/standard-library/regex-operators.md ✅Succeeded
docs/standard-library/regex-typedefs.md ✅Succeeded
docs/standard-library/scoped-allocator-operators.md ✅Succeeded
docs/standard-library/sstream-functions.md ✅Succeeded
docs/standard-library/sstream-typedefs.md ✅Succeeded
docs/standard-library/streambuf-typedefs.md ✅Succeeded
docs/standard-library/string-functions.md ✅Succeeded

This comment lists only the first 25 files in the pull request.
For more details, please refer to the build report.

For any questions, please:

Copy link
Contributor

PRMerger Results

Issue Description
Changed Files This PR contains more than 10 changed files.

@v-dirichards
Copy link
Contributor

@TylerMSFT

Can you review the proposed changes?

Important: When the changes are ready for publication, adding a #sign-off comment is the best way to signal that the PR is ready for the review team to merge.

#label:"aq-pr-triaged"
@MicrosoftDocs/public-repo-pr-review-team

@prmerger-automator prmerger-automator bot added the aq-pr-triaged Tracking label for the PR review team label May 21, 2025
Copy link
Collaborator

@TylerMSFT TylerMSFT left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is good cleanup. The reason for this situation is that 'In this article' is a feature the platform team added that automatically generates links to the titles. Problem is, for the many topics we have that were basically providing this functionality manually, we now have the duplication that you noticed. Thank you for fixing these up.

@TylerMSFT
Copy link
Collaborator

#sign-off

@v-dirichards
Copy link
Contributor

@TylerMSFT These changes all turn into blockers because they remove the required introductory info between the H1 and the first H2. Could you add at least a 1 sentence introduction back into these articles?

#hold-off


References
Important: Contributor guidance has moved to https://learn.microsoft.com/help/

To access the guides, you must log in with your Learn profile. If you don't have a Learn profile, follow the instructions at Manage your Microsoft Learn profile settings | Microsoft Learn to create one.

Pull request quality criteria

  • (Blocking) The article must contain an introductory paragraph between the H1 and the first H2 heading.

Copy link
Contributor

Learn Build status updates of commit 9e5ffa6:

✅ Validation status: passed

File Status Preview URL Details
docs/parallel/amp/reference/concurrency-graphics-namespace-functions.md ✅Succeeded
docs/parallel/amp/reference/concurrency-namespace-constants-amp.md ✅Succeeded
docs/parallel/amp/reference/concurrency-namespace-enums-amp.md ✅Succeeded
docs/parallel/openmp/c-openmp-c-and-cpp-grammar.md ✅Succeeded
docs/standard-library/atomic-functions.md ✅Succeeded
docs/standard-library/fstream-typedefs.md ✅Succeeded
docs/standard-library/future-enums.md ✅Succeeded
docs/standard-library/future-functions.md ✅Succeeded
docs/standard-library/hash-map-functions.md ✅Succeeded
docs/standard-library/hash-map-operators.md ✅Succeeded
docs/standard-library/hash-set-functions.md ✅Succeeded
docs/standard-library/hash-set-operators.md ✅Succeeded
docs/standard-library/iomanip-functions.md ✅Succeeded
docs/standard-library/istream-functions.md ✅Succeeded
docs/standard-library/istream-typedefs.md ✅Succeeded
docs/standard-library/locale-functions.md ✅Succeeded
docs/standard-library/ostream-operators.md ✅Succeeded
docs/standard-library/ostream-typedefs.md ✅Succeeded
docs/standard-library/regex-operators.md ✅Succeeded
docs/standard-library/regex-typedefs.md ✅Succeeded
docs/standard-library/scoped-allocator-operators.md ✅Succeeded
docs/standard-library/sstream-functions.md ✅Succeeded
docs/standard-library/sstream-typedefs.md ✅Succeeded
docs/standard-library/streambuf-typedefs.md ✅Succeeded
docs/standard-library/string-functions.md ✅Succeeded

This comment lists only the first 25 files in the pull request.
For more details, please refer to the build report.

For any questions, please:

Copy link
Contributor

PRMerger Results

Issue Description
Changed Files This PR contains more than 10 changed files.
File Change Percent This PR contains file(s) with more than 30% file change.

Copy link
Contributor

Learn Build status updates of commit 05b3e39:

✅ Validation status: passed

File Status Preview URL Details
docs/parallel/amp/reference/concurrency-graphics-namespace-functions.md ✅Succeeded
docs/parallel/amp/reference/concurrency-namespace-constants-amp.md ✅Succeeded
docs/parallel/amp/reference/concurrency-namespace-enums-amp.md ✅Succeeded
docs/parallel/openmp/c-openmp-c-and-cpp-grammar.md ✅Succeeded
docs/standard-library/atomic-functions.md ✅Succeeded
docs/standard-library/fstream-typedefs.md ✅Succeeded
docs/standard-library/future-enums.md ✅Succeeded
docs/standard-library/future-functions.md ✅Succeeded
docs/standard-library/hash-map-functions.md ✅Succeeded
docs/standard-library/hash-map-operators.md ✅Succeeded
docs/standard-library/hash-set-functions.md ✅Succeeded
docs/standard-library/hash-set-operators.md ✅Succeeded
docs/standard-library/iomanip-functions.md ✅Succeeded
docs/standard-library/istream-functions.md ✅Succeeded
docs/standard-library/istream-typedefs.md ✅Succeeded
docs/standard-library/locale-functions.md ✅Succeeded
docs/standard-library/ostream-operators.md ✅Succeeded
docs/standard-library/ostream-typedefs.md ✅Succeeded
docs/standard-library/regex-operators.md ✅Succeeded
docs/standard-library/regex-typedefs.md ✅Succeeded
docs/standard-library/scoped-allocator-operators.md ✅Succeeded
docs/standard-library/sstream-functions.md ✅Succeeded
docs/standard-library/sstream-typedefs.md ✅Succeeded
docs/standard-library/streambuf-typedefs.md ✅Succeeded
docs/standard-library/string-functions.md ✅Succeeded

This comment lists only the first 25 files in the pull request.
For more details, please refer to the build report.

For any questions, please:

Copy link
Contributor

PRMerger Results

Issue Description
Changed Files This PR contains more than 10 changed files.
File Change Percent This PR contains file(s) with more than 30% file change.

Copy link
Contributor

Learn Build status updates of commit a409eee:

✅ Validation status: passed

File Status Preview URL Details
docs/parallel/amp/reference/concurrency-graphics-namespace-functions.md ✅Succeeded
docs/parallel/amp/reference/concurrency-namespace-constants-amp.md ✅Succeeded
docs/parallel/amp/reference/concurrency-namespace-enums-amp.md ✅Succeeded
docs/parallel/openmp/c-openmp-c-and-cpp-grammar.md ✅Succeeded
docs/standard-library/atomic-functions.md ✅Succeeded
docs/standard-library/fstream-typedefs.md ✅Succeeded
docs/standard-library/future-enums.md ✅Succeeded
docs/standard-library/future-functions.md ✅Succeeded
docs/standard-library/hash-map-functions.md ✅Succeeded
docs/standard-library/hash-map-operators.md ✅Succeeded
docs/standard-library/hash-set-functions.md ✅Succeeded
docs/standard-library/hash-set-operators.md ✅Succeeded
docs/standard-library/iomanip-functions.md ✅Succeeded
docs/standard-library/istream-functions.md ✅Succeeded
docs/standard-library/istream-typedefs.md ✅Succeeded
docs/standard-library/locale-functions.md ✅Succeeded
docs/standard-library/ostream-operators.md ✅Succeeded
docs/standard-library/ostream-typedefs.md ✅Succeeded
docs/standard-library/regex-operators.md ✅Succeeded
docs/standard-library/regex-typedefs.md ✅Succeeded
docs/standard-library/scoped-allocator-operators.md ✅Succeeded
docs/standard-library/sstream-functions.md ✅Succeeded
docs/standard-library/sstream-typedefs.md ✅Succeeded
docs/standard-library/streambuf-typedefs.md ✅Succeeded
docs/standard-library/string-functions.md ✅Succeeded

This comment lists only the first 25 files in the pull request.
For more details, please refer to the build report.

For any questions, please:

Copy link
Contributor

PRMerger Results

Issue Description
Changed Files This PR contains more than 10 changed files.
Commits Count This PR contains more than 15 commits.
File Change Percent This PR contains file(s) with more than 30% file change.

Copy link
Contributor

Learn Build status updates of commit a0a5ab9:

✅ Validation status: passed

File Status Preview URL Details
docs/parallel/amp/reference/concurrency-graphics-namespace-functions.md ✅Succeeded
docs/parallel/amp/reference/concurrency-namespace-constants-amp.md ✅Succeeded
docs/parallel/amp/reference/concurrency-namespace-enums-amp.md ✅Succeeded
docs/parallel/openmp/c-openmp-c-and-cpp-grammar.md ✅Succeeded
docs/standard-library/atomic-functions.md ✅Succeeded
docs/standard-library/fstream-typedefs.md ✅Succeeded
docs/standard-library/future-enums.md ✅Succeeded
docs/standard-library/future-functions.md ✅Succeeded
docs/standard-library/hash-map-functions.md ✅Succeeded
docs/standard-library/hash-map-operators.md ✅Succeeded
docs/standard-library/hash-set-functions.md ✅Succeeded
docs/standard-library/hash-set-operators.md ✅Succeeded
docs/standard-library/iomanip-functions.md ✅Succeeded
docs/standard-library/istream-functions.md ✅Succeeded
docs/standard-library/istream-typedefs.md ✅Succeeded
docs/standard-library/locale-functions.md ✅Succeeded
docs/standard-library/ostream-operators.md ✅Succeeded
docs/standard-library/ostream-typedefs.md ✅Succeeded
docs/standard-library/regex-operators.md ✅Succeeded
docs/standard-library/regex-typedefs.md ✅Succeeded
docs/standard-library/scoped-allocator-operators.md ✅Succeeded
docs/standard-library/sstream-functions.md ✅Succeeded
docs/standard-library/sstream-typedefs.md ✅Succeeded
docs/standard-library/streambuf-typedefs.md ✅Succeeded
docs/standard-library/string-functions.md ✅Succeeded

This comment lists only the first 25 files in the pull request.
For more details, please refer to the build report.

For any questions, please:

Copy link
Contributor

PRMerger Results

Issue Description
Changed Files This PR contains more than 10 changed files.
Commits Count This PR contains more than 15 commits.
File Change Percent This PR contains file(s) with more than 30% file change.

Copy link
Contributor

Learn Build status updates of commit 66643fc:

✅ Validation status: passed

File Status Preview URL Details
docs/parallel/amp/reference/concurrency-graphics-namespace-functions.md ✅Succeeded
docs/parallel/amp/reference/concurrency-namespace-constants-amp.md ✅Succeeded
docs/parallel/amp/reference/concurrency-namespace-enums-amp.md ✅Succeeded
docs/parallel/openmp/c-openmp-c-and-cpp-grammar.md ✅Succeeded
docs/standard-library/atomic-functions.md ✅Succeeded
docs/standard-library/fstream-typedefs.md ✅Succeeded
docs/standard-library/future-enums.md ✅Succeeded
docs/standard-library/future-functions.md ✅Succeeded
docs/standard-library/hash-map-functions.md ✅Succeeded
docs/standard-library/hash-map-operators.md ✅Succeeded
docs/standard-library/hash-set-functions.md ✅Succeeded
docs/standard-library/hash-set-operators.md ✅Succeeded
docs/standard-library/iomanip-functions.md ✅Succeeded
docs/standard-library/istream-functions.md ✅Succeeded
docs/standard-library/istream-typedefs.md ✅Succeeded
docs/standard-library/locale-functions.md ✅Succeeded
docs/standard-library/ostream-operators.md ✅Succeeded
docs/standard-library/ostream-typedefs.md ✅Succeeded
docs/standard-library/regex-operators.md ✅Succeeded
docs/standard-library/regex-typedefs.md ✅Succeeded
docs/standard-library/scoped-allocator-operators.md ✅Succeeded
docs/standard-library/sstream-functions.md ✅Succeeded
docs/standard-library/sstream-typedefs.md ✅Succeeded
docs/standard-library/streambuf-typedefs.md ✅Succeeded
docs/standard-library/string-functions.md ✅Succeeded

This comment lists only the first 25 files in the pull request.
For more details, please refer to the build report.

For any questions, please:

Copy link
Contributor

PRMerger Results

Issue Description
Changed Files This PR contains more than 10 changed files.
Commits Count This PR contains more than 15 commits.
File Change Percent This PR contains file(s) with more than 30% file change.

Copy link
Contributor

Learn Build status updates of commit 3407ae9:

✅ Validation status: passed

File Status Preview URL Details
docs/parallel/amp/reference/concurrency-graphics-namespace-functions.md ✅Succeeded
docs/parallel/amp/reference/concurrency-namespace-constants-amp.md ✅Succeeded
docs/parallel/amp/reference/concurrency-namespace-enums-amp.md ✅Succeeded
docs/parallel/openmp/c-openmp-c-and-cpp-grammar.md ✅Succeeded
docs/standard-library/atomic-functions.md ✅Succeeded
docs/standard-library/fstream-typedefs.md ✅Succeeded
docs/standard-library/future-enums.md ✅Succeeded
docs/standard-library/future-functions.md ✅Succeeded
docs/standard-library/hash-map-functions.md ✅Succeeded
docs/standard-library/hash-map-operators.md ✅Succeeded
docs/standard-library/hash-set-functions.md ✅Succeeded
docs/standard-library/hash-set-operators.md ✅Succeeded
docs/standard-library/iomanip-functions.md ✅Succeeded
docs/standard-library/istream-functions.md ✅Succeeded
docs/standard-library/istream-typedefs.md ✅Succeeded
docs/standard-library/locale-functions.md ✅Succeeded
docs/standard-library/ostream-operators.md ✅Succeeded
docs/standard-library/ostream-typedefs.md ✅Succeeded
docs/standard-library/regex-operators.md ✅Succeeded
docs/standard-library/regex-typedefs.md ✅Succeeded
docs/standard-library/scoped-allocator-operators.md ✅Succeeded
docs/standard-library/sstream-functions.md ✅Succeeded
docs/standard-library/sstream-typedefs.md ✅Succeeded
docs/standard-library/streambuf-typedefs.md ✅Succeeded
docs/standard-library/string-functions.md ✅Succeeded

This comment lists only the first 25 files in the pull request.
For more details, please refer to the build report.

For any questions, please:

Copy link
Contributor

PRMerger Results

Issue Description
Changed Files This PR contains more than 10 changed files.
Commits Count This PR contains more than 15 commits.
File Change Percent This PR contains file(s) with more than 30% file change.

@TylerMSFT
Copy link
Collaborator

#sign-off

I added the required text between the H1 and H2.
@Rageking8, I started doing other cleanup like code escape, etc. but the day was far spent and I need to move on to other things. I think the work you did to remove what will appear as duplicate links was a good thing. If we pursue more of it, we need to include some descriptive text between the title and the first H2.

Copy link
Contributor

Learn Build status updates of commit eee5982:

✅ Validation status: passed

File Status Preview URL Details
docs/parallel/amp/reference/concurrency-graphics-namespace-functions.md ✅Succeeded
docs/parallel/amp/reference/concurrency-namespace-constants-amp.md ✅Succeeded
docs/parallel/amp/reference/concurrency-namespace-enums-amp.md ✅Succeeded
docs/parallel/openmp/c-openmp-c-and-cpp-grammar.md ✅Succeeded
docs/standard-library/atomic-functions.md ✅Succeeded
docs/standard-library/fstream-typedefs.md ✅Succeeded
docs/standard-library/future-enums.md ✅Succeeded
docs/standard-library/future-functions.md ✅Succeeded
docs/standard-library/hash-map-functions.md ✅Succeeded
docs/standard-library/hash-map-operators.md ✅Succeeded
docs/standard-library/hash-set-functions.md ✅Succeeded
docs/standard-library/hash-set-operators.md ✅Succeeded
docs/standard-library/iomanip-functions.md ✅Succeeded
docs/standard-library/istream-functions.md ✅Succeeded
docs/standard-library/istream-typedefs.md ✅Succeeded
docs/standard-library/locale-functions.md ✅Succeeded
docs/standard-library/ostream-operators.md ✅Succeeded
docs/standard-library/ostream-typedefs.md ✅Succeeded
docs/standard-library/regex-operators.md ✅Succeeded
docs/standard-library/regex-typedefs.md ✅Succeeded
docs/standard-library/scoped-allocator-operators.md ✅Succeeded
docs/standard-library/sstream-functions.md ✅Succeeded
docs/standard-library/sstream-typedefs.md ✅Succeeded
docs/standard-library/streambuf-typedefs.md ✅Succeeded
docs/standard-library/string-functions.md ✅Succeeded

This comment lists only the first 25 files in the pull request.
For more details, please refer to the build report.

For any questions, please:

Copy link
Contributor

PRMerger Results

Issue Description
Changed Files This PR contains more than 10 changed files.
Commits Count This PR contains more than 15 commits.
File Change Percent This PR contains file(s) with more than 30% file change.

@TylerMSFT
Copy link
Collaborator

#sign-off

@v-dirichards
Copy link
Contributor

#sign-off

I added the required text between the H1 and H2. @Rageking8, I started doing other cleanup like code escape, etc. but the day was far spent and I need to move on to other things. I think the work you did to remove what will appear as duplicate links was a good thing. If we pursue more of it, we need to include some descriptive text between the title and the first H2.

@TylerMSFT I really appreciate all the extra work put in to fix the blockers. Now merging.

@v-dirichards v-dirichards merged commit d4a4f41 into MicrosoftDocs:main May 29, 2025
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants