Skip to content

Commit

Permalink
Update algorithm documentation issue template
Browse files Browse the repository at this point in the history
  • Loading branch information
bobluppes authored Aug 6, 2023
1 parent 27f9099 commit 18c5a95
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion .github/ISSUE_TEMPLATE/algorithm-documentation-template.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,12 @@ The goal of this issue if the improve the documentation of an existing algorithm

More detail on how to build the documentation locally can be found on the [wiki](https://github.com/bobluppes/graaf/wiki/development-setup#documentation).

An existing documentation page exists, which should be extended. The page can be found under `docs/docs/algorithms/`
An existing documentation page exists, which should be extended. The page can be found under `docs/docs/algorithms/`.
OR
A new documentation page should be created under `docs/docs/algorithms`. Potentially, a new subdirectory should be created for the algorithm's category.

The corresponding algorithm is called `` and can be found under `include/graaflib/algorithm/`.

## Documentation Contents
The documentation entry should adhere to the following template:

Expand Down

0 comments on commit 18c5a95

Please sign in to comment.