Skip to content

Commit dd4ad19

Browse files
committed
docs: make release documentation links portable
1 parent 95118dd commit dd4ad19

2 files changed

Lines changed: 34 additions & 48 deletions

File tree

README.md

Lines changed: 25 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -39,8 +39,10 @@ while keeping the API intentionally small and explicit.
3939
- ✅ Stack storage only (no heap allocation in core types)
4040
-`unsafe` forbidden
4141

42-
See [CHANGELOG.md](CHANGELOG.md) for release history and
43-
[docs/roadmap.md](docs/roadmap.md) for current release planning.
42+
See [CHANGELOG.md](https://github.com/acgetchell/la-stack/blob/v0.4.3/CHANGELOG.md)
43+
for release history and
44+
[docs/roadmap.md](https://github.com/acgetchell/la-stack/blob/v0.4.3/docs/roadmap.md)
45+
for current release planning.
4446

4547
## 🚫 Anti-goals
4648

@@ -371,9 +373,10 @@ finite-storage invariant directly, so kernels do not revalidate stored entries.
371373

372374
## 📊 Benchmarks (vs nalgebra/faer)
373375

374-
![LU solve (factor + solve): median time vs dimension](docs/assets/bench/vs_linalg_lu_solve_median.svg)
376+
![LU solve (factor + solve): median time vs dimension](https://raw.githubusercontent.com/acgetchell/la-stack/v0.4.3/docs/assets/bench/vs_linalg_lu_solve_median.svg)
375377

376-
Raw data: [docs/assets/bench/vs_linalg_lu_solve_median.csv](docs/assets/bench/vs_linalg_lu_solve_median.csv)
378+
Raw data:
379+
[docs/assets/bench/vs_linalg_lu_solve_median.csv](https://github.com/acgetchell/la-stack/blob/v0.4.3/docs/assets/bench/vs_linalg_lu_solve_median.csv)
377380

378381
Representative benchmark: `lu_solve` factors the matrix and solves one
379382
right-hand side. Median time is lower-is-better, and the “la-stack vs
@@ -382,9 +385,10 @@ nalgebra/faer” columns show the % time reduction relative to each baseline
382385
operations.
383386

384387
For the full per-kernel comparison methodology, input construction, and
385-
release-comparison workflow details, see [docs/BENCHMARKING.md](docs/BENCHMARKING.md).
388+
release-comparison workflow details, see
389+
[docs/BENCHMARKING.md](https://github.com/acgetchell/la-stack/blob/v0.4.3/docs/BENCHMARKING.md).
386390
For the current release-to-release performance snapshot, see
387-
[docs/PERFORMANCE.md](docs/PERFORMANCE.md).
391+
[docs/PERFORMANCE.md](https://github.com/acgetchell/la-stack/blob/v0.4.3/docs/PERFORMANCE.md).
388392

389393
<!-- BENCH_TABLE:lu_solve:median:new:BEGIN -->
390394

@@ -445,23 +449,30 @@ to an explicit allowlist, and kept with readable version comments for review.
445449
CI runs `just ci` on Ubuntu, macOS, and Windows to keep platform coverage
446450
aligned with the local comprehensive validation path.
447451

448-
For coverage commands and report locations, see [`docs/COVERAGE.md`](docs/COVERAGE.md).
449-
For the full contributor workflow, see [CONTRIBUTING.md](CONTRIBUTING.md).
452+
For coverage commands and report locations, see
453+
[`docs/COVERAGE.md`](https://github.com/acgetchell/la-stack/blob/v0.4.3/docs/COVERAGE.md).
454+
For the full contributor workflow, see
455+
[CONTRIBUTING.md](https://github.com/acgetchell/la-stack/blob/v0.4.3/CONTRIBUTING.md).
450456

451457
## 📝 Citation
452458

453-
If you use this library in academic work, please cite it using [CITATION.cff](CITATION.cff) (or GitHub's
454-
"Cite this repository" feature). Tagged releases are archived on Zenodo.
459+
If you use this library in academic work, please cite it using
460+
[CITATION.cff](https://github.com/acgetchell/la-stack/blob/v0.4.3/CITATION.cff)
461+
(or GitHub's "Cite this repository" feature). Tagged releases are archived on
462+
Zenodo.
455463

456464
## 📚 References
457465

458-
For canonical references to the algorithms used by this crate, see [REFERENCES.md](REFERENCES.md).
466+
For canonical references to the algorithms used by this crate, see
467+
[REFERENCES.md](https://github.com/acgetchell/la-stack/blob/v0.4.3/REFERENCES.md).
459468

460469
## 🤖 AI Agents
461470

462-
AI coding assistants should read [AGENTS.md](AGENTS.md) before proposing or
463-
applying changes. See [CONTRIBUTING.md](CONTRIBUTING.md) for the repository's
464-
AI-assisted development note.
471+
AI coding assistants should read
472+
[AGENTS.md](https://github.com/acgetchell/la-stack/blob/v0.4.3/AGENTS.md)
473+
before proposing or applying changes. See
474+
[CONTRIBUTING.md](https://github.com/acgetchell/la-stack/blob/v0.4.3/CONTRIBUTING.md)
475+
for the repository's AI-assisted development note.
465476

466477
## 📄 License
467478

scripts/README.md

Lines changed: 9 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -14,60 +14,35 @@ uv sync --group dev
1414

1515
## How to use it
1616

17-
### Comparing latest performance against the last release
17+
### Comparing performance
1818

1919
The comparison script reads Criterion output and writes a local report to
2020
`target/bench-reports/performance.md` by default:
2121

2222
```bash
23-
# Save a full release baseline named "last"
24-
just bench-save-last
25-
26-
# Run exact benches plus la-stack rows from vs_linalg, then compare to last
27-
just bench-latest-vs-last
28-
29-
# Run only non-exact la-stack rows from vs_linalg, then compare to last
30-
just bench-vs-linalg-latest-vs
31-
3223
# Re-render from existing Criterion output
3324
just bench-compare
3425
```
3526

3627
Use `uv run bench-compare --snapshot` for a no-baseline snapshot, or
3728
`uv run bench-compare <baseline>` to compare against a named saved baseline.
3829

39-
For release PRs, promote one curated release-to-release comparison into
40-
committed docs and archive the previous committed report. Benchmark generation
41-
runs locally in temporary worktrees:
42-
43-
```bash
44-
just performance-release
45-
```
46-
47-
For local development regression checks, compare the current in-tree code
48-
against the latest published release:
30+
Use the top-level `just` workflows for routine release and local comparisons:
4931

5032
```bash
33+
# Local development: compare the current tree with the latest release
5134
just performance-local
52-
```
53-
54-
For a faster non-exact kernel check that skips current nalgebra/faer and exact
55-
benchmark runs, compare current la-stack `vs_linalg` rows against a release
56-
baseline:
5735

58-
```bash
59-
just performance-local-vs-linalg v0.4.3 v0.4.2
60-
```
61-
62-
To compare stored GitHub Actions release benchmark assets without local cargo
63-
runs:
36+
# Release PR: update docs/PERFORMANCE.md and archive the previous report
37+
just performance-release
6438

65-
```bash
39+
# GitHub Actions release assets, without local cargo benchmark runs
6640
just performance-github-assets
6741
```
6842

69-
For explicit release repair, pass both tags:
70-
`just performance-release v0.4.3 v0.4.2`.
43+
See `docs/BENCHMARKING.md` for the current command matrix, local saved-baseline
44+
workflow, explicit tag arguments, output locations, and release-artifact
45+
comparison details.
7146

7247
### Plotting Criterion benchmarks (la-stack vs nalgebra/faer)
7348

0 commit comments

Comments
 (0)