Skip to content

Update C++ TOC and update settings links #8334

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

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

AlexandraKemperMS
Copy link
Collaborator

Removed references to the settings page (which has changed names at this point) and updated the TOC since now an additional level of nesting is supported. The debugging docs have been put under one header - this will be updated more as these docs are changed. I will double check with the CMake team about the CMake docs

Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR updates documentation in the C++ configuration guides to reflect the renaming of the settings page and introduce an additional nesting level in the table of contents.

  • Removed outdated references to the settings page.
  • Updated documentation links to point to the new settings file (customize-cpp-settings.md).
  • Adjusted the TOC structure for enhanced nesting.

Reviewed Changes

Copilot reviewed 2 out of 3 changed files in this pull request and generated no comments.

File Description
docs/cpp/configure-intellisense.md Updated references from the old schema file to the new settings file.
docs/cpp/configure-intellisense-crosscompilation.md Updated references similarly and adjusted the bullet list formatting.
Files not reviewed (1)
  • docs/toc.json: Language not supported
Comments suppressed due to low confidence (1)

docs/cpp/configure-intellisense-crosscompilation.md:78

  • [nitpick] The bullet list marker was changed from '--' to '-' in this section. For consistency across the document, consider verifying that all bullet points use the same marker style.
- Explore the [c_cpp_properties schema](/docs/cpp/customize-cpp-settings.md).

Copy link

@timscharfenort8 timscharfenort8 left a comment

Choose a reason for hiding this comment

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

Good work

@ntrogh
Copy link
Contributor

ntrogh commented May 1, 2025

@AlexandraKemperMS When you create subnodes in the ToC, make sure to:

  • Update the area for the subnode
  • Create a corresponding folder in the repo and move the articles in there
  • Update the link to the articles to include that subfolder

The process is still a bit different from that on MS Learn...

@AlexandraKemperMS
Copy link
Collaborator Author

@AlexandraKemperMS When you create subnodes in the ToC, make sure to:

  • Update the area for the subnode
  • Create a corresponding folder in the repo and move the articles in there
  • Update the link to the articles to include that subfolder

The process is still a bit different from that on MS Learn...

I took another stab at it - let me know if this is what you meant or I need to make more edits!

Copy link
Contributor

@ntrogh ntrogh left a comment

Choose a reason for hiding this comment

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

@AlexandraKemperMS Thanks for the updates. The only change needed is to rename the folders to match the values of the area field.

I'll update the contributor guidance to make it clearer.

@ntrogh
Copy link
Contributor

ntrogh commented May 5, 2025

@AlexandraKemperMS I didn't make myself clear enough. The actual folders within the docset need to match the area value, so they need to be renamed as well. For example, "Getting Started" -> "gettingstarted"

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants