docs: correct dielectric scope and refresh docs for public repo#5
Merged
Conversation
Accuracy fixes (the dielectric params are informational only; calcl.c reports effective er / loss on stderr but does not apply them to the R/L/|Z| matrices): - Add a Scope note to the README overview and reframe the "Understanding the Physics" section/table as background theory the tool does not compute. - Mark the dielectric features accordingly; fix the Backward Compatibility wording. - INSTALL.md: explain air vs FR4 producing identical output is expected. - YAML_USER_GUIDE.md: relabel "Required Dielectric Parameters" as optional and informational. Staleness / onboarding fixes: - INSTALL.md Step 1: replace the bogus "unzip weeks_yaml.zip" with git clone. - README: replace the dead Meschach homepage download URL with the Debian source-package route (+ -fcommon note for GCC 10+). - Rewrite the directory structure to match the repo (correct root name, 5 example files incl. test_single.yaml, tools/, docs/ both files, .github/, diagnostic_report.md, YAML_USER_GUIDE.md, test.yaml). - Clarify RO4350B has no example file. Polish: - MIT license wording; GitHub Issues link in Support; surface check-fasthenry and the pytest suite in Quick Start; fix the quasi-static validity vs 2 GHz example inconsistency. Co-Authored-By: Claude Opus 4.8 <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.
Documentation review and cleanup now that the repo is public. Cross-checked every claim against the code.
Tier 1 — Accuracy (these were misleading)
calcl.c:80–92computes effective εr / dielectric loss but prints them to stderr and does not apply them to the R/L/|Z| matrices. The docs implied otherwise (headline "dielectric loss modeling", a "What Changes with Dielectric?" table claiming Z0/capacitance/velocity changes the tool never computes, "compare air vs FR4 results"). Added a Scope note, reframed the physics section/table as background theory, and corrected Backward Compatibility + INSTALL troubleshooting so identical air/FR4 output reads as expected.unzip weeks_yaml.zip— replaced withgit clone.-fcommonnote for GCC 10+).Tier 2 — Stale facts
test_single.yaml), thetools/harness, bothdocs/files,.github/,diagnostic_report.md, etc.Tier 3 — Polish
make check-fasthenryandpytest tools/fh_crosscheck/in Quick Start; fixed quasi-static "~1 GHz" vs the 2 GHz example.No code changes.
🤖 Generated with Claude Code