conformallab/ConformalLabpp
3
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity

docs: fix 2 broken internal links

Browse Source 
- doc/release-policy.md:85 corrected `doc/api/tests.md` link to relative
  `api/tests.md` (was resolving to nonexistent doc/doc/api/tests.md).
- doc/tutorials/block-fd-hessian.md:40 redirected stale reference
  `../math/hyper-ideal.md` to the actual file `../math/geometry-modes.md`.

Found by a sweep of all doc/*.md before the reviewer meeting.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
This commit is contained in:
Tarik Moussa
2026-05-23 23:09:40 +02:00
parent b569daa388
commit 0b1bf07232
2 changed files with 2 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
doc/release-policy.md
View File

@@ -82,7 +82,7 @@ rule is:
| Number / string | Single source of truth | Anywhere else | | Number / string | Single source of truth | Anywhere else |
|-----------------------------|--------------------------------|--------------------------------------| |-----------------------------|--------------------------------|--------------------------------------|
| **Total / per-suite test counts** | `doc/api/tests.md` | Use qualitative phrasing + link, e.g. "full test suite passes, 0 skipped — see [`doc/api/tests.md`](doc/api/tests.md)". | | **Total / per-suite test counts** | `doc/api/tests.md` | Use qualitative phrasing + link, e.g. "full test suite passes, 0 skipped — see [`doc/api/tests.md`](api/tests.md)". |
| **Project version** | `CITATION.cff` `version:` field | Don't hardcode in headers, READMEs, doc bodies. Reference by name ("v0.9.0") only when the historical version actually matters (changelog entries, release-note bodies, Phase-milestone tables). | | **Project version** | `CITATION.cff` `version:` field | Don't hardcode in headers, READMEs, doc bodies. Reference by name ("v0.9.0") only when the historical version actually matters (changelog entries, release-note bodies, Phase-milestone tables). |
| **Release date** | `CITATION.cff` `date-released:` + `CHANGELOG.md` section header | Don't hardcode elsewhere. | | **Release date** | `CITATION.cff` `date-released:` + `CHANGELOG.md` section header | Don't hardcode elsewhere. |
| **Test-suite description per file** | `doc/api/tests.md` | Headers and code files may list the suites they implement, but never claim a count of suites elsewhere. | | **Test-suite description per file** | `doc/api/tests.md` | Headers and code files may list the suites they implement, but never claim a count of suites elsewhere. |

2
doc/tutorials/block-fd-hessian.md
View File

@@ -37,7 +37,7 @@ as `face_angles_from_local_dofs(...)`.
> for circle patterns and Koebe's theorem.* Trans. AMS 356(2), 659–689. > for circle patterns and Koebe's theorem.* Trans. AMS 356(2), 659–689.
**Prerequisite:** familiarity with the hyper-ideal functional itself **Prerequisite:** familiarity with the hyper-ideal functional itself
(see [`doc/math/hyper-ideal.md`](../math/hyper-ideal.md)), and with the (see [`doc/math/geometry-modes.md`](../math/geometry-modes.md)), and with the
generic functional-porting pattern of generic functional-porting pattern of
[`doc/tutorials/add-inversive-distance.md`](add-inversive-distance.md). [`doc/tutorials/add-inversive-distance.md`](add-inversive-distance.md).