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

[BUG] No documentation #5

Open
milen-prg opened this issue Apr 6, 2024 · 1 comment
Open

[BUG] No documentation #5

milen-prg opened this issue Apr 6, 2024 · 1 comment

Comments

@milen-prg
Copy link

In "documentation" is written:

API documentation

The API documentation is generated from the XML comments included in the source code. All methods and properties should be documented in compliance with the StyleCop rules.
User’s guide

The user’s guide contains “hand-written” information about the library. The user’s guide is provided online (html) and as a printable file (pdf).

BUT there is NO references, NO guide (dreamed PDF), NOTHING!
May be it's my search fault, but HOW to learn to use this seemingly amazing toolkit?! I can't dig in its source, because, I'm beginner and want to USE the Helix Toolkit, not to develop it!!!

Thanks, in advance!

@holance
Copy link
Member

holance commented Apr 6, 2024

There are plenty of examples in the examples folder.

There are also some guides in the wiki page

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

2 participants