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

Documentation #190

Open
FreakyAli opened this issue Jun 26, 2024 · 3 comments
Open

Documentation #190

FreakyAli opened this issue Jun 26, 2024 · 3 comments

Comments

@FreakyAli
Copy link

FreakyAli commented Jun 26, 2024

Love your work here, and wanted to know if you have some kind of documentation for this control that would guide me to use it better, if not I would like to know if you would be willing for me to help you with it, If you don't mind I would like to fork this and create a document for you that documents everything you need to know about this control and I would like for your to review it!!!

@symbiogenesis
Copy link
Collaborator

symbiogenesis commented Jul 1, 2024

Hi there,

Feel free to send a pull request. There isn't any great documentation. The XML code comments, IntelliSense, the Sample project, and the README file are about all we have. Most of what is here follows typical conventions for DataGrids.

Using Markdown files and/or a static site generator is the right approach. GitHub Pages offers options for this, but ideally it should be something that is not overly tied to GitHub. The GitHub Wiki, for instance, is entirely tied to GitHub. But some static site generators can target GitHub Pages without restricting you to that.

@FreakyAli
Copy link
Author

@symbiogenesis Why should it not be tied to Github though?

@symbiogenesis
Copy link
Collaborator

The documentation should be part of the repository itself, version controlled, and portable to other cloud git hosting companies.

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