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

Added documentation #31

Merged
merged 14 commits into from
Nov 25, 2021
Merged

Added documentation #31

merged 14 commits into from
Nov 25, 2021

Conversation

danielbekhter
Copy link

Added XML code documentation as well as markdown articles.

@danielbekhter danielbekhter added the documentation Improvements or additions to documentation label Nov 23, 2021
@danielbekhter danielbekhter self-assigned this Nov 23, 2021
Copy link
Member

@BenediktHensen BenediktHensen left a 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.

@BenediktHensen BenediktHensen merged commit 54f7571 into develop Nov 25, 2021
@BenediktHensen BenediktHensen deleted the code_documentation branch November 25, 2021 18:28
@BenediktHensen BenediktHensen linked an issue Nov 25, 2021 that may be closed by this pull request
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add DocFX documentation
2 participants