Skip to content

Commit

Permalink
Improve extension documentation (#871)
Browse files Browse the repository at this point in the history
  • Loading branch information
pascalberger authored Dec 29, 2024
1 parent 62c9efc commit 6894103
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 12 deletions.
10 changes: 0 additions & 10 deletions docs/docs/documentation/extending/fundamentals.md

This file was deleted.

6 changes: 6 additions & 0 deletions docs/docs/documentation/extending/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,9 @@
title: Extending
description: Instructions how to add support for additional analyzers, report formats and pull request system to the Cake Issues Addin.
---

Cake Issues can easily be extended with additional [Issue Provider], [Report Formats] and [Pull Request System integrations].

[Issue Provider]: issue-provider/overview.md
[Report Formats]: report-format/overview.md
[Pull Request System integrations]: pull-request-system/overview.md
6 changes: 5 additions & 1 deletion docs/docs/documentation/extending/testing.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,9 @@ title: Testing
description: Instructions how to write test cases for Cake Issues addins.
---

The `Cake.Issues.Testing` packages provides different helper classes for writing test cases
The [Cake.Issues.Testing]{target="_blank"} package provides different helper classes for writing test cases
for issue provider, report format or pull request system addins.

[API Documentation on fuget.org](https://www.fuget.org/packages/Cake.Issues.Testing){ target="_blank" .md-button .md-button--primary }

[Cake.Issues.Testing]: https://www.nuget.org/packages/Cake.Issues.Testing
1 change: 0 additions & 1 deletion docs/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -231,7 +231,6 @@ nav:
- How To Develop:
- Extending:
- documentation/extending/index.md
- Fundamentals: documentation/extending/fundamentals.md
- Issue Provider:
- Overview: documentation/extending/issue-provider/overview.md
- Alias Categories: documentation/extending/issue-provider/categories.md
Expand Down

0 comments on commit 6894103

Please sign in to comment.