diff --git a/docfx_project/index.md b/docfx_project/index.md index 9bc17e9..af52845 100644 --- a/docfx_project/index.md +++ b/docfx_project/index.md @@ -2,8 +2,41 @@ _layout: landing --- -# Title +# Wolfgang.Extensions.IComparable Documentation -## Quick Start Notes: +Welcome to the Wolfgang.Extensions.IComparable documentation. This site contains the API reference and getting-started guides for the library. - +## Quick Links + +- [Getting Started](docs/getting-started.md) — install and first usage +- [Introduction](docs/introduction.md) — what the library solves and why +- [API Reference](api/Wolfgang.Extensions.IComparable.html) — complete API +- [GitHub Repository](https://github.com/Chris-Wolfgang/IComparable-Extensions) — source code + +## About Wolfgang.Extensions.IComparable + +Extension methods for `IComparable` that make ordering and range checks read the way you'd say them — `value.IsBetween(low, high)` instead of `value.CompareTo(low) > 0 && value.CompareTo(high) < 0`. + +## Installation + +```bash +dotnet add package Wolfgang.Extensions.IComparable +``` + +## Documentation Sections + +### 📖 [Getting Started](docs/getting-started.md) +Step-by-step instructions for installing the package and using `IsBetween` / `IsInRange` in your project. + +### 📚 [API Reference](api/Wolfgang.Extensions.IComparable.html) +Complete API documentation automatically generated from source XML comments. + +## Additional Resources + +- [Contributing Guidelines](https://github.com/Chris-Wolfgang/IComparable-Extensions/blob/main/CONTRIBUTING.md) +- [Code of Conduct](https://github.com/Chris-Wolfgang/IComparable-Extensions/blob/main/CODE_OF_CONDUCT.md) +- [License](https://github.com/Chris-Wolfgang/IComparable-Extensions/blob/main/LICENSE) + +--- + +*Documentation built with [DocFX](https://dotnet.github.io/docfx/)* diff --git a/docs/setup.md b/docs/setup.md index 2eec0d5..7db6c32 100644 --- a/docs/setup.md +++ b/docs/setup.md @@ -119,7 +119,7 @@ reportgenerator -reports:"TestResults/**/coverage.cobertura.xml" \ ```bash # Run only unit tests -dotnet test tests/Wolfgang.Extensions.IComparable.Tests/Wolfgang.Extensions.IComparable.Tests.csproj +dotnet test tests/Wolfgang.Extensions.IComparable.Tests.Unit/Wolfgang.Extensions.IComparable.Tests.Unit.csproj ``` ## Code Quality Checks @@ -168,8 +168,8 @@ IComparable-Extensions/ │ ├── Wolfgang.Extensions.IComparable.csproj │ └── IComparableExtensions.cs ├── tests/ -│ └── Wolfgang.Extensions.IComparable.Tests/ -│ ├── Wolfgang.Extensions.IComparable.Tests.csproj +│ └── Wolfgang.Extensions.IComparable.Tests.Unit/ +│ ├── Wolfgang.Extensions.IComparable.Tests.Unit.csproj │ └── IComparableExtensionsTests.cs ├── benchmarks/ │ └── (Benchmark projects)