-
Notifications
You must be signed in to change notification settings - Fork 5
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
Added documentation #31
Conversation
Linked the articles in the DocFX folder structure
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I added cross-references using the xref:uid
links. Moreover, each sentence should be in its own line so that we can track changes to the documentation easier. I also updated the headlines so that they follow proper APA capitalization standards.
There was also something strange going on with the API part of the documentation and it failed to generate. I updated the settings and now we get the full API documentation, too. Unity also generates an error because the package references itself in the Unity project, so I removed this circular dependency.
With these changes, the pull request can be merged.
Added XML code documentation as well as markdown articles.