docs: fix grammar, stale refs, and missing example file across docs#8
Merged
Conversation
…o tree - Remove diagnostic_report.md entry from directory tree (file does not exist) - Remove its reference from the Validation section - Add test_microstrip.yaml to the examples/ tree; correct count 5 → 6 Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…in YAML guide - INSTALL.md: add test_microstrip.yaml to the 'What You Get' file list - YAML_USER_GUIDE.md: remove dead YAML_MIGRATION_GUIDE.md reference - YAML_USER_GUIDE.md: update 'Last Updated' date to June 8, 2026 Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
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
1 participant
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.
Summary
Audit of all markdown files and examples, fixing confirmed issues:
diagnostic_report.mdreferences (file does not exist in repo); add missingtest_microstrip.yamlto examples directory tree and fix count 5 → 6test_microstrip.yamlto the "What You Get" file listYAML_MIGRATION_GUIDE.md(file never existed); update "Last Updated" date"Can not"→"Cannot"in error messageAll 6 example YAML files were verified geometrically correct (substrate heights, parameter values, comments) — no changes needed there.
Test plan
make clean && make— clean build, no new warningsgrep -rn "diagnostic_report" .— returns nothinggrep -rn "YAML_MIGRATION_GUIDE" .— returns nothinggrep "test_microstrip" README.md INSTALL.md— present in both🤖 Generated with Claude Code