diff --git a/docs/src/examples.md b/docs/src/examples.md index 4b57b26..7e42bed 100644 --- a/docs/src/examples.md +++ b/docs/src/examples.md @@ -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) diff --git a/docs/src/home.md b/docs/src/home.md index 833be33..18c0c7c 100644 --- a/docs/src/home.md +++ b/docs/src/home.md @@ -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 diff --git a/docs/src/installation.md b/docs/src/installation.md index d7e709c..5319d90 100644 --- a/docs/src/installation.md +++ b/docs/src/installation.md @@ -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) diff --git a/docs/src/usage.md b/docs/src/usage.md index ce4040d..1e391cd 100644 --- a/docs/src/usage.md +++ b/docs/src/usage.md @@ -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 @@ -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