Skip to content

[FEATURE REQUEST] Add authored documentation #78

@jharmer95

Description

@jharmer95

Feature Request: Add authored documentation

Brief Summary of Request

Currently, doxygen-generated documentation is used.
This can be helpful to an extent, but a fully authored, customized set of docs could help better explain the ins and outs of the library.
The doxygen docs should still exist for contributors (exposing everything including internal namespaces).

What Is The Value Added With This Feature

New users of the library will have a better understanding of the library and its general use, tips/tricks, and sharp edges to watch out for.

Possible Implementation

Adding a manually authored Markdown document, utilizing the GitHub wiki feature

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions