Skip to content

D5: audit other markdown files (closes #103) #132

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
Chris-Wolfgang merged 3 commits into from
Jun 2, 2026
Merged

D5: audit other markdown files (closes #103) #132

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6074f18
D5: audit other markdown files (closes #103)
Chris-Wolfgang Jun 1, 2026
e70883e
Address PR #132 review comments — relative API Reference links
Chris-Wolfgang Jun 2, 2026
7482204
Merge branch 'vNext' into stack/d5-other-markdown
Chris-Wolfgang Jun 2, 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
39 changes: 36 additions & 3 deletions docfx_project/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

<!--1. Add images to the *images* folder if the file is referencing an image.-->
## 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<T>` 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/)*
6 changes: 3 additions & 3 deletions docs/setup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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)
Expand Down