Migrate guideline notes/tips/exceptions to markdown callouts#407
Merged
Conversation
Agent-Logs-Url: https://github.com/dennisdoomen/CSharpGuidelines/sessions/2204c2c3-0c9b-4950-bc91-79931ab96c96 Co-authored-by: dennisdoomen <572734+dennisdoomen@users.noreply.github.com>
Agent-Logs-Url: https://github.com/dennisdoomen/CSharpGuidelines/sessions/2204c2c3-0c9b-4950-bc91-79931ab96c96 Co-authored-by: dennisdoomen <572734+dennisdoomen@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Update notes and tips to use markdown-style callouts
Migrate guideline notes/tips/exceptions to markdown callouts
May 16, 2026
Agent-Logs-Url: https://github.com/dennisdoomen/CSharpGuidelines/sessions/2204c2c3-0c9b-4950-bc91-79931ab96c96 Co-authored-by: dennisdoomen <572734+dennisdoomen@users.noreply.github.com>
7fc2be6 to
aa88041
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This updates the remaining guideline rules that still used inline
**Tip:**/**Note:**/**Exception:**markers to the newer markdown callout format already used by rule 0105. It also preserves readable rendering for both site and PDF output, including a consistent treatment for exception-style callouts.Content migration
_rules/*.mdto markdown alerts.IMPORTANTalerts while retaining anException/Exceptionsheading in rendered output.Site rendering
PDF/build compatibility
Build/Build.csso the Pandoc-based document build renders callouts as readable blockquotes with headings instead of raw[!TIP]markers.Repo hygiene
.gitignoreforBuild/binandBuild/objso generated build artifacts are not picked up by future changes.Example of the migrated rule format:
Warning
Firewall rules blocked me from connecting to one or more addresses (expand for details)
I tried to connect to the following addresses, but was blocked by firewall rules:
accounts.google.com/proc/self/exe /proc/self/exe --type=utility --utility-sub-type=network.mojom.NetworkService --lang=en-US --service-sandbox-type=none --no-sandbox --use-angle=swiftshader-webgl --crashpad-handler-pid=6845 --enable-crash-reporter=, --noerrdialogs --user-data-dir=/tmp/com.google.Chrome.scoped_dir.D3V9mB --change-stack-guard-on-fork=enable --shared-files=v8_context_snapshot_data:100 --field-trial-handle=3,i,9592831306724523143,12243666612889944347,262144 --disable-features=PaintHolding --variations-seed-version --pseudonymization-salt-handle=7,i,3815473962287697219,9040442960276991393,4 --trace-process-track-uuid=3190708989122997041 -I y-3.2.0(dns block)/opt/google/chrome/chrome /usr/bin/google-chrome --headless --disable-gpu --no-sandbox --screenshot=/tmp/callout-demo.png --window-size=1200,900 file:///tmp/callout-demo.html by-3.2.0 -I kward -I -gcc -qui�� 86_64-linux-gnu/1 uby-3.2.0/ruby/b1 e/ruby/3.2.0/gem/var/log/sysstat /usr/include/rubgit e/ruby/3.2.0/gem--no-pager E=3 u/13/collect2(dns block)clients2.google.com/proc/self/exe /proc/self/exe --type=utility --utility-sub-type=network.mojom.NetworkService --lang=en-US --service-sandbox-type=none --no-sandbox --use-angle=swiftshader-webgl --crashpad-handler-pid=6845 --enable-crash-reporter=, --noerrdialogs --user-data-dir=/tmp/com.google.Chrome.scoped_dir.D3V9mB --change-stack-guard-on-fork=enable --shared-files=v8_context_snapshot_data:100 --field-trial-handle=3,i,9592831306724523143,12243666612889944347,262144 --disable-features=PaintHolding --variations-seed-version --pseudonymization-salt-handle=7,i,3815473962287697219,9040442960276991393,4 --trace-process-track-uuid=3190708989122997041 -I y-3.2.0(dns block)/opt/google/chrome/chrome /usr/bin/google-chrome --headless --disable-gpu --no-sandbox --screenshot=/tmp/callout-demo.png --window-size=1200,900 file:///tmp/callout-demo.html by-3.2.0 -I kward -I -gcc -qui�� 86_64-linux-gnu/1 uby-3.2.0/ruby/b1 e/ruby/3.2.0/gem/var/log/sysstat /usr/include/rubgit e/ruby/3.2.0/gem--no-pager E=3 u/13/collect2(dns block)clientservices.googleapis.com/proc/self/exe /proc/self/exe --type=utility --utility-sub-type=network.mojom.NetworkService --lang=en-US --service-sandbox-type=none --no-sandbox --use-angle=swiftshader-webgl --crashpad-handler-pid=6845 --enable-crash-reporter=, --noerrdialogs --user-data-dir=/tmp/com.google.Chrome.scoped_dir.D3V9mB --change-stack-guard-on-fork=enable --shared-files=v8_context_snapshot_data:100 --field-trial-handle=3,i,9592831306724523143,12243666612889944347,262144 --disable-features=PaintHolding --variations-seed-version --pseudonymization-salt-handle=7,i,3815473962287697219,9040442960276991393,4 --trace-process-track-uuid=3190708989122997041 -I y-3.2.0(dns block)/opt/google/chrome/chrome /usr/bin/google-chrome --headless --disable-gpu --no-sandbox --screenshot=/tmp/callout-demo.png --window-size=1200,900 file:///tmp/callout-demo.html by-3.2.0 -I kward -I -gcc -qui�� 86_64-linux-gnu/1 uby-3.2.0/ruby/b1 e/ruby/3.2.0/gem/var/log/sysstat /usr/include/rubgit e/ruby/3.2.0/gem--no-pager E=3 u/13/collect2(dns block)https://api.github.com/repos/dennisdoomen/csharpguidelines/pages/usr/bin/ruby3.2 ruby3.2 /home/REDACTED/work/CSharpGuidelines/CSharpGuidelines/vendor/bundle/ruby/3.2.0/bin/jekyll build --gdwarf-5 --64 -o pipe.o /tmp/ccQ4Wd8b.s -I s/prism-1.9.0/ext lines/vendor/bun. as -I ruby-3.2.0 ackward by/3.2.0/bin/as p=BUILDDIR=. y-3.2.0/ruby/bac-I otection y-3.2.0(http block)/usr/bin/ruby3.2 ruby3.2 /home/REDACTED/work/CSharpGuidelines/CSharpGuidelines/vendor/bundle/ruby/3.2.0/bin/jekyll build --config _config.yml,/tmp/csharpguidelines-no-github.yml . ruby-3.2.0 ackward p=BUILDDIR=. r-strong otection as ecur�� . 4.7 by-3.2.0 -I kward -I y-3.2.0(http block)redirector.gvt1.com/proc/self/exe /proc/self/exe --type=utility --utility-sub-type=network.mojom.NetworkService --lang=en-US --service-sandbox-type=none --no-sandbox --use-angle=swiftshader-webgl --crashpad-handler-pid=6845 --enable-crash-reporter=, --noerrdialogs --user-data-dir=/tmp/com.google.Chrome.scoped_dir.D3V9mB --change-stack-guard-on-fork=enable --shared-files=v8_context_snapshot_data:100 --field-trial-handle=3,i,9592831306724523143,12243666612889944347,262144 --disable-features=PaintHolding --variations-seed-version --pseudonymization-salt-handle=7,i,3815473962287697219,9040442960276991393,4 --trace-process-track-uuid=3190708989122997041 -I y-3.2.0(dns block)/opt/google/chrome/chrome /usr/bin/google-chrome --headless --disable-gpu --no-sandbox --screenshot=/tmp/callout-demo.png --window-size=1200,900 file:///tmp/callout-demo.html by-3.2.0 -I kward -I -gcc -qui�� 86_64-linux-gnu/1 uby-3.2.0/ruby/b1 e/ruby/3.2.0/gem/var/log/sysstat /usr/include/rubgit e/ruby/3.2.0/gem--no-pager E=3 u/13/collect2(dns block)safebrowsingohttpgateway.googleapis.com/proc/self/exe /proc/self/exe --type=utility --utility-sub-type=network.mojom.NetworkService --lang=en-US --service-sandbox-type=none --no-sandbox --use-angle=swiftshader-webgl --crashpad-handler-pid=6845 --enable-crash-reporter=, --noerrdialogs --user-data-dir=/tmp/com.google.Chrome.scoped_dir.D3V9mB --change-stack-guard-on-fork=enable --shared-files=v8_context_snapshot_data:100 --field-trial-handle=3,i,9592831306724523143,12243666612889944347,262144 --disable-features=PaintHolding --variations-seed-version --pseudonymization-salt-handle=7,i,3815473962287697219,9040442960276991393,4 --trace-process-track-uuid=3190708989122997041 -I y-3.2.0(dns block)/opt/google/chrome/chrome /usr/bin/google-chrome --headless --disable-gpu --no-sandbox --screenshot=/tmp/callout-demo.png --window-size=1200,900 file:///tmp/callout-demo.html by-3.2.0 -I kward -I -gcc -qui�� 86_64-linux-gnu/1 uby-3.2.0/ruby/b1 e/ruby/3.2.0/gem/var/log/sysstat /usr/include/rubgit e/ruby/3.2.0/gem--no-pager E=3 u/13/collect2(dns block)www.google.com/proc/self/exe /proc/self/exe --type=utility --utility-sub-type=network.mojom.NetworkService --lang=en-US --service-sandbox-type=none --no-sandbox --use-angle=swiftshader-webgl --crashpad-handler-pid=6845 --enable-crash-reporter=, --noerrdialogs --user-data-dir=/tmp/com.google.Chrome.scoped_dir.D3V9mB --change-stack-guard-on-fork=enable --shared-files=v8_context_snapshot_data:100 --field-trial-handle=3,i,9592831306724523143,12243666612889944347,262144 --disable-features=PaintHolding --variations-seed-version --pseudonymization-salt-handle=7,i,3815473962287697219,9040442960276991393,4 --trace-process-track-uuid=3190708989122997041 -I y-3.2.0(dns block)/opt/google/chrome/chrome /usr/bin/google-chrome --headless --disable-gpu --no-sandbox --screenshot=/tmp/callout-demo.png --window-size=1200,900 file:///tmp/callout-demo.html by-3.2.0 -I kward -I -gcc -qui�� 86_64-linux-gnu/1 uby-3.2.0/ruby/b1 e/ruby/3.2.0/gem/var/log/sysstat /usr/include/rubgit e/ruby/3.2.0/gem--no-pager E=3 u/13/collect2(dns block)If you need me to access, download, or install something from one of these locations, you can either: