search

akgulebubekir / Maui.DataGrid

DataGrid component for Maui
MIT License
261 stars 54 forks source link

Documentation #190

Open FreakyAli opened 5 months ago

FreakyAli commented 5 months ago

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 commented 5 months ago

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 commented 5 months ago

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

symbiogenesis commented 5 months ago

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