Conversation
PoliCheck Scan ReportThe following report lists PoliCheck issues in PR files. Before you merge the PR, you must fix all severity-1 issues. Other issues are also a high priority. The AI Review Details column lists suggestions for either removing or replacing the terms. If you find a false positive result, mention it in a PR comment and include this text: #policheck-false-positive. This feedback helps reduce false positives in future scans. ✅ No issues foundMore information about PoliCheckInformation: PoliCheck | Severity Guidance | Term |
|
Learn Build status updates of commit 6f3b565: ✅ Validation status: passed
For more details, please refer to the build report. |
PRMerger Results
|
|
|
||
| [Cross-references to related documentation:] | ||
|
|
||
| - [vcpkg Maintainer Guide](./maintainer-guide.md) |
There was a problem hiding this comment.
I'm not an expert on copilot reading this stuff but I think there may be confusion with [] used to denote "replacements" above with the markdown URL syntax used here.
| - **Never create duplicate H2 headings** within the same document | ||
| - **Always use relative paths** for internal links (./filename.md) | ||
| - **Follow markdown formatting rules** defined in .markdownlint.jsonc | ||
| - **Maintain line length limits** (120 characters for prose) |
There was a problem hiding this comment.
| - **Maintain line length limits** (120 characters for prose) | |
| - **Maintain line length limits** (120 characters for prose) but don't edit something only to restore a length limit |
There was a problem hiding this comment.
Also why are some of these bold and some not?
| - **Repository**: vcpkg-docs (Microsoft's vcpkg package manager documentation) | ||
| - **Audience**: Developers using vcpkg for C++ package management | ||
| - **Platform**: Microsoft Docs publishing system | ||
| - **Primary Shell**: PowerShell (pwsh.exe) on Windows |
There was a problem hiding this comment.
| - **Primary Shell**: PowerShell (pwsh.exe) on Windows | |
| - **Primary Shell**: PowerShell (pwsh.exe) on Windows, zsh on macOS, bash on Linux |
| ### Links to Avoid | ||
|
|
||
| - External links that may break over time | ||
| - Deep links into other repositories' documentation |
There was a problem hiding this comment.
What's wrong with these?
|
|
||
| ### Voice and Tone | ||
|
|
||
| - **Authoritative but approachable**: Be confident and knowledgeable while remaining accessible |
There was a problem hiding this comment.
In my experience these things are already fairly confident and asking them to be even more confident may increase the risk of hallucinations but 🤷
| # Use PowerShell syntax for Windows examples | ||
| vcpkg install boost | ||
|
|
||
| # Use appropriate shell for cross-platform examples |
There was a problem hiding this comment.
Bash example? Also what about @JavierMatosD 's zone pivots?
3 participants
Render: https://review.learn.microsoft.com/en-us/vcpkg/contributing/documentation-style-guide?branch=pr-en-us-523