Skip to content
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.

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

Add documentation #13

Open
2 tasks
asasine opened this issue Apr 19, 2021 · 0 comments
Open
2 tasks

Add documentation #13

asasine opened this issue Apr 19, 2021 · 0 comments

Comments

@asasine
Copy link
Owner

asasine commented Apr 19, 2021

Documentation could be hosted on GitHub Wiki or Pages. Using the Wiki or Pages would require upgrading this repository to public.

Documentation should include:

  • Examples
  • References to the code

References to the code should utilize C# documentation comments. Tools such as DocFX can export the comments to HTML for use with GitHub Pages.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant