docs: align Week 9 CUI with Integrity Code Series canonical standard#1
Merged
Conversation
- Standardise the badge row to the 6-badge canonical order (CI, License MIT, Python 3.11+, Tests 154 passing, Code style ruff, DOI) with working hrefs - Correct the tests badge and Quickstart count to the real pytest total (154) - Add docs/equations.html: a MathJax reference rendering only the governing equations already present in the README/source, preserving [ASSUMED] tags - Link docs/equations.html from the Governing Equations section - Resolve the MIT-vs-"research/educational only" contradiction: keep MIT in License, move the usage restriction into a new Disclaimer section - Add Disclaimer (canonical text), Anti-Hallucination Note (T1/T2/T3 tiers) and rename Cybersecurity Summary to Cybersecurity (STRIDE) - Update the series cross-link table: bold Week 9, add Week 11, refresh slugs - Fix Repository Structure: list docs/ and the existing tests/test_extended.py
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.
Brings the published Week 9 CUI repo up to the Integrity Code Series canonical standard (content only — no repo rename, no default-branch change). All existing technical content is preserved.
Changes
ci.yml), License MIT, Python 3.11+, Tests 154 passing (→tests/), Code style ruff, DOI (10.5281/zenodo.20172508).pytesttotal (154 collected). Repository Structure now also lists the existingtests/test_extended.pyand the newdocs/.tex-mml-chtml) adapted from the Week 11 skeleton. Renders only the governing equations already in this repo's README/source (Fourier, Philip-de Vries, Butler-Volmer, Faraday, Strang, Tikhonov, Monte Carlo/PoF, API 579-1 FAD), preserving the repo's own[ASSUMED]tags and citations. No equation, constant, or citation was invented.docs/equations.html.## License; moved the usage restriction into a new## Disclaimerwith the canonical text.## Disclaimer,## Anti-Hallucination Note(T1/T2/T3 tiers mapped to the repo's[ASSUMED]flags), and renamedCybersecurity Summary→## Cybersecurity (STRIDE).Verification
pytest --collect-only→ 154 tests collected (badge, Quickstart, footer all say 154).[]()badge hrefs; 6 badges in fixed order.