Skip to content

Commit e47d2c6

Browse files
MercurieVVclaude
andcommitted
docs: fix live-site 404s from relative links to repo source paths
Docusaurus build flagged these as broken: they linked to repo source directories/files (analysis/, core/, mcp/, stryker4s.conf, compat-fixtures/src/main) that the published docs site does not serve — correct as GitHub-relative paths, but dead on the live site since Docusaurus only hosts the docs/ tree. Converted to plain code spans instead of links, since there's nowhere on the site for them to point. Verified via a full local `docusaurus build` + `serve`: 0 broken links except one pre-existing false positive (a fenced code sample meant for a different file, correctly using its own relative path). Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01DYMBTKayWeQihL2YyQRUid
1 parent ce4a4a5 commit e47d2c6

2 files changed

Lines changed: 8 additions & 8 deletions

File tree

docs/research/stryker4s-alert-strategy.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ Due to the high runtime cost of running mutation tests (estimated 5-15 mins for
4545
- **Nightly Run**: Trigger a full mutation test run on the `master` branch every night via a cron schedule. This records the baseline health of the codebase.
4646
- **On-Demand PR Run (Label-Gated)**: Run mutation testing on a pull request only if:
4747
- The PR has the label `ci:run-mutation` applied.
48-
- The PR modifies critical business logic inside the [analysis](../../analysis/) module.
48+
- The PR modifies critical business logic inside the `analysis` module.
4949

5050
### Isolation (Avoiding SemanticDB Pollution)
5151
As identified in the research report, sbt compilation during a Stryker run overwrites target class directories and generates polluted SemanticDB files.
@@ -57,9 +57,9 @@ As identified in the research report, sbt compilation during a Stryker run overw
5757

5858
We recommend rolling out mutation testing in phases:
5959

60-
1. **Phase 1: `analysis` module** ([analysis](../../analysis/)): Focus here first. This contains the semantic analysis engine where logic is dense and test coverage is critical.
61-
2. **Phase 2: `core` module** ([core](../../core/)): Roll out once `analysis` is stable. Since `core` handles static SemanticDB parsing and has stable structure, its threshold can be set higher (e.g. `85%`).
62-
3. **Phase 3: `mcp` module** ([mcp](../../mcp/)): The stdio JSON-RPC loop contains infinite loops and blocking network channels that are difficult to mutate without triggering infinite loops or timeouts. We recommend excluding the stdio channel from mutations.
60+
1. **Phase 1: `analysis` module**: Focus here first. This contains the semantic analysis engine where logic is dense and test coverage is critical.
61+
2. **Phase 2: `core` module**: Roll out once `analysis` is stable. Since `core` handles static SemanticDB parsing and has stable structure, its threshold can be set higher (e.g. `85%`).
62+
3. **Phase 3: `mcp` module**: The stdio JSON-RPC loop contains infinite loops and blocking network channels that are difficult to mutate without triggering infinite loops or timeouts. We recommend excluding the stdio channel from mutations.
6363

6464
### Implementation note from #133
6565

@@ -83,7 +83,7 @@ resolved:
8383
## 5. Configuration Sketch
8484

8585
### HOCON Config (`stryker4s.conf`)
86-
The HOCON configuration file [stryker4s.conf](../../stryker4s.conf) should be structured as follows:
86+
The HOCON configuration file `stryker4s.conf` should be structured as follows:
8787

8888
```hocon
8989
stryker4s {

docs/testing/compat-strategy.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,9 @@ For each compiler feature area and Scala version, we evaluate whether to (a) ven
2525
The new layout will introduce version-segregated files for newly-vendored and custom code:
2626

2727
Status: this file list was the original plan; the fixtures actually landed under different names
28-
(see [`compat-fixtures/src/main`](../../compat-fixtures/src/main) for the current layout —
29-
`CallGraph.scala`, `ProductRecord.scala`, and, Scala-3-only, `VersionSpecific.scala`). Kept as a
30-
historical record of the intended structure, not a current file listing.
28+
in `compat-fixtures/src/main` (`CallGraph.scala`, `ProductRecord.scala`, and, Scala-3-only,
29+
`VersionSpecific.scala`). Kept as a historical record of the intended structure, not a current
30+
file listing.
3131

3232
### Scala 2.13 Files (as planned)
3333
Path: `compat-fixtures/src/main/scala-2.13/com/github/mercurievv/scalasemantic/compat/`

0 commit comments

Comments
 (0)