Skip to content

Fix 404 broken links in documentation for benchmark setup pages #180

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rvhonorato merged 2 commits into from
Apr 21, 2026
Merged

Fix 404 broken links in documentation for benchmark setup pages #180

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f39250d
Initial plan
Copilot Apr 21, 2026
5ff7f0a
Fix broken 404 documentation links for benchmark setup pages
Copilot Apr 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/src/examples.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -309,7 +309,7 @@ Use these examples as templates and:

## Additional Resources

- **Complete configuration reference**: [Writing a Benchmark YAML File](./writing-a-benchmark.yaml-file.md)
- **Input list format guide**: [Writing an Input List File](./writing-a-input.list-file.md)
- **Running benchmarks**: [Running Haddock Runner](./running-haddock-runner.md)
- **Complete configuration reference**: [Writing a Benchmark YAML File](./usage.md#step-3-write-the-benchmark-configuration)
- **Input list format guide**: [Writing an Input List File](./usage.md#step-2-create-the-input-list-file)
- **Running benchmarks**: [Running Haddock Runner](./usage.md#step-4-run-the-benchmark)
- **Real-world setup**: [Setting Up a Benchmark](./setting-up-bm5.md)
2 changes: 1 addition & 1 deletion docs/src/home.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ Results are organized by scenario and target, making it easy to compare performa
4. **List your input files** in the required format
5. **Run the benchmark** and analyze results

See the [Setting Up a Benchmark](/setting-up-bm5) and [Writing a Benchmark YAML File](/writing-a-benchmark.yaml-file) sections for detailed instructions.
See the [Setting Up a Benchmark](/setting-up-bm5) and [Writing a Benchmark YAML File](/usage#step-3-write-the-benchmark-configuration) sections for detailed instructions.

## Getting Help

Expand Down
6 changes: 3 additions & 3 deletions docs/src/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,6 +145,6 @@ If you encounter installation issues:
Now that you have `haddock-runner` installed, you're ready to:

1. **Set up your first benchmark** - See [Setting Up a Benchmark](/setting-up-bm5)
2. **Write a configuration file** - See [Writing a Benchmark YAML File](/writing-a-benchmark.yaml-file)
3. **Prepare your input files** - See [Writing a Input List File](/writing-a-input.list-file)
4. **Run your benchmark** - See [Running Haddock Runner](/running-haddock-runner)
2. **Write a configuration file** - See [Writing a Benchmark YAML File](/usage#step-3-write-the-benchmark-configuration)
3. **Prepare your input files** - See [Writing an Input List File](/usage#step-2-create-the-input-list-file)
4. **Run your benchmark** - See [Running Haddock Runner](/usage#step-4-run-the-benchmark)
4 changes: 2 additions & 2 deletions docs/src/usage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ scenarios:
cmrest: true
```

See [Writing a Benchmark YAML File](./writing-a-benchmark.yaml-file.md) for complete configuration options.
See [Writing a Benchmark YAML File](#step-3-write-the-benchmark-configuration) for complete configuration options.

### Step 4: Run the Benchmark

Expand All @@ -127,7 +127,7 @@ haddock-runner --debug benchmark.yaml
4. Results organization in the working directory
5. Progress logging and error handling

See [Running Haddock Runner](./running-haddock-runner.md) for runtime details.
See [Running the Benchmark](#step-4-run-the-benchmark) for runtime details.

### Step 5: Analyze Results

Expand Down
Loading