ni / VireoSDK

Compact runtime for a subset of LabVIEW
Other
49 stars 44 forks source link

Documentation Simplification #678

Closed rajsite closed 3 years ago

rajsite commented 3 years ago

Before this change there were multiple locations for various pieces of documentation: The markdown files (README, CONTRIBUTING, etc), text files in the Documentation folder, and generated Doxygen documentation.

This change simplifies the documentation by migrating it all to Markdown files (migrating txt files to markdown and removing the doxygen built docs that add little value over source code navigation on GitHub).

This allows for easier contribution (with similar Markdown workflows as the NI Developer Wiki) and easier navigation.

You can see an example here: https://github.com/rajsite/VireoSDK/tree/markdown-only-docs