Skip to content

Commit

Permalink
* added new documentation readme page which contains categorized link…
Browse files Browse the repository at this point in the history
…s to all dother documentation pages in this repository with brief description

* documentaiton section in repo readme file updated with a link to documentation readme
  • Loading branch information
Kuba Drazka committed Oct 3, 2024
1 parent 983f4b1 commit ef1b2fa
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 4 deletions.
5 changes: 1 addition & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,7 @@ Finding these benchmarks in a separate repository might be surprising. Performan

## Documentation

* [Microbenchmarks Guide](./src/benchmarks/micro/README.md) for information on running our microbenchmarks
* [Scenario Tests Guide](./docs/scenarios-workflow.md) for information on running our real-world scenario benchmarks
* [Benchmarking workflow for dotnet/runtime repository](./docs/benchmarking-workflow-dotnet-runtime.md) for information on benchmarking local [dotnet/runtime](https://github.com/dotnet/runtime) builds
* [Profiling workflow for dotnet/runtime repository](./docs/profiling-workflow-dotnet-runtime.md) for information on profiling local [dotnet/runtime](https://github.com/dotnet/runtime) builds
See the [documentation signpost](./docs/readme.md).

## Contributing to Repository

Expand Down
25 changes: 25 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# .NET Performance Repository Documentation Readme

The documentation in this repo is organized into the following sections:

## Getting Started

- [Prerequisites](prerequisites.md) - Information on what you need to get started.
- [Perfreport walktrough](perfreport-walktrough.md) - This document describes Performance Report Advanced Features.
- [Crank to Helix workflow](crank-to-helix-workflow.md) - Information on how to schedule performance tests to be run on Helix machines using Crank (instead of running locally).
- [Profiling workflow dotnet runtime](profiling-workflow-dotnet-runtime.md) - This doc explains how to profile local [dotnet/runtime](https://github.com/dotnet/runtime) builds and it's targetted at [dotnet/runtime](https://github.com/dotnet/runtime) repository contributors.

## Running Benchmarks

- [BenchmarkDotNet](benchmarkdotnet.md) - Information of how to run benchmarks using BenchmarkDotNet tool and interpret results.
- [Benchmarking workflow](benchmarking-workflow-dotnet-runtime.md) - Information about the (micro)benchmarks for the [dotnet/runtime](https://github.com/dotnet/runtime) in this repository.
- [Microbenchmarks Guide](../src/benchmarks/micro/README.md) for information on running our microbenchmarks.
- [Microbenchmarks design guidelines](microbenchmark-design-guidelines.md) - Detailed guidelines on how to design and write microbenchmarks.

## Running Scenarios

- [Scenarios workflow](scenarios-workflow.md) - An introduction of how to run scenario tests.
- [Basic scenarios](basic-scenarios.md) - Specific instruction of how to run various basic scenarios.
- [Blazor scenarios](blazor-scenarios) - Specific instruction of how to run _New Blazorwasm Template Size On Disk_ scenarios.
- [Cross-gen scenarios](crossgen-scenarios.md) - Specific instruction of how to run _crossgen_ scenarios.
- [SDK scenarios](sdk-scenarios.md) - Specific instruction of how to run _SDK Build Throughput Scenario_ scenarios.

0 comments on commit ef1b2fa

Please sign in to comment.