Skip to content

Restructure the opening pages of our docs - #4309

Merged
AArnott merged 5 commits into
masterfrom
docs-work
Oct 15, 2026
Merged

AArnott merged 5 commits into
masterfrom
docs-work

Conversation

@AArnott

@AArnott AArnott commented Oct 15, 2026

Copy link
Copy Markdown
Contributor

No description provided.

@AArnott
AArnott enabled auto-merge October 15, 2026 11:44
Copilot AI balanced review requested due to automatic review settings October 15, 2026 11:44

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🟡 Changes recommended

Broken activation-help links and outdated sidebar test expectations need correction.

1 open finding
What changed in this PR

Consolidates StyleCop.Analyzers onboarding documentation across English, Czech, Russian, and Simplified Chinese.

Changes:

  • Moves installation and XML documentation setup into overview pages.
  • Adds stylecop.json setup instructions to configuration guides.
  • Removes standalone setup pages and updates navigation and solution entries.
File Description
StyleCopAnalyzers.slnx Updates documentation entries.
documentation/​zh-cn/​toc.yml Removes obsolete navigation entries.
documentation/​zh-cn/​index.md Consolidates onboarding guidance.
documentation/​zh-cn/​EnableConfiguration.md Removes standalone activation guide.
documentation/​zh-cn/​DotNetCli.md Removes standalone CLI guide.
documentation/​zh-cn/​Configuration.md Adds JSON setup guidance.
documentation/​toc.yml Removes obsolete navigation entries.
documentation/​ru-ru/​toc.yml Removes obsolete navigation entries.
documentation/​ru-ru/​index.md Consolidates onboarding guidance.
documentation/​ru-ru/​EnableConfiguration.md Removes standalone activation guide.
documentation/​ru-ru/​DotNetCli.md Removes standalone CLI guide.
documentation/​ru-ru/​Configuration.md Adds JSON setup guidance.
documentation/​index.md Consolidates onboarding guidance.
documentation/​EnableConfiguration.md Removes standalone activation guide.
documentation/​DotNetCli.md Removes standalone CLI guide.
documentation/​cs-cz/​toc.yml Removes obsolete navigation entries.
documentation/​cs-cz/​index.md Consolidates onboarding guidance.
documentation/​cs-cz/​EnableConfiguration.md Removes standalone activation guide.
documentation/​cs-cz/​DotNetCli.md Removes standalone CLI guide.
documentation/​cs-cz/​Configuration.md Adds JSON setup guidance.
documentation/​Configuration.md Adds JSON setup guidance.

🧠 Review effort: Balanced


💡 Configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread documentation/cs-cz/toc.yml Resolved
@codecov

codecov Bot commented Oct 15, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 97.62%. Comparing base (aeb5e09) to head (feb4bca).
⚠️ Report is 1 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #4309   +/-   ##
=======================================
  Coverage   97.62%   97.62%           
=======================================
  Files        1308     1308           
  Lines      142251   142251           
  Branches     4749     4749           
=======================================
  Hits       138869   138869           
  Misses       2156     2156           
  Partials     1226     1226           
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@AArnott
AArnott marked this pull request as draft October 15, 2026 12:50
auto-merge was automatically disabled October 15, 2026 12:50

Pull request was converted to draft

AArnott and others added 2 commits October 15, 2026 07:07
The opening-page restructure removed the .NET CLI and configuration-enabling sidebar entries. Update the expected labels while retaining exact source and compiled-navigation assertions.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
The standalone EnableConfiguration page was removed when its content moved into Configuration. Link directly to the stylecop.json section so markup link validation succeeds.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@AArnott
AArnott marked this pull request as ready for review October 15, 2026 13:17
Copilot AI balanced review requested due to automatic review settings October 15, 2026 13:17

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🔵 Needs a closer look

The deleted activation page remains the help destination embedded in generated stylecop.json files.

0 open findings

1 resolved since last review
Previously missed (1)

In code that hasn't changed since last review

Medium severity Preserve activation-help URL when removing EnableConfiguration.html

documentation/​EnableConfiguration.md:1

Deleting this page breaks the activation-help URL in SettingsFileCodeFixProvider.cs:25–30. Generated stylecop.json files tell users that additional setup is required, then direct them to EnableConfiguration.html, which this change stops producing. Preserve that URL with a compatibility page or redirect to Configuration.html#using-stylecopjson, and update the template for future files. Updating the template alone would leave existing generated files with a broken link.

🧠 Review effort: Balanced

Copilot AI balanced review requested due to automatic review settings October 15, 2026 14:06

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🔵 Needs a closer look

The deleted activation page is still linked from generated configuration files, leaving users without the referenced setup instructions.

0 open findings

🧠 Review effort: Balanced

Copilot AI balanced review requested due to automatic review settings October 15, 2026 14:10

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🔵 Needs a closer look

Deleting the configuration setup page breaks help links embedded in existing generated settings files.

0 open findings

Previously missed (1)

In code that hasn't changed since last review

Medium severity Retain EnableConfiguration.md compatibility page for existing links

documentation/​EnableConfiguration.md:1

Deleting this page breaks the ACTION REQUIRED link to EnableConfiguration.html embedded in previously generated stylecop.json files. Updating the code-fix template only changes future files. Retain EnableConfiguration.md as a short compatibility page linking to Configuration.md#using-stylecopjson, so both the Markdown page and its published HTML URL remain usable.

🧠 Review effort: Balanced

This was referenced Nov 13, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants