WinUI.TableView icon indicating copy to clipboard operation
WinUI.TableView copied to clipboard

Documentation

Open Georgios1999 opened this issue 3 months ago • 9 comments

Is your feature request related to a problem? Please describe. I found it really hard to get things started with the TableView, since there was no documentation. I was able to figure it out later, but things would be way less complicated if the repo had its own documentation, especially for beginner devs.

Describe the solution you'd like Documentation. I can contribute to that too. Maybe GitHub Pages, or just markup docs in the files, detailing what each thing does and some example uses. More than what the desktop app has to offer, like the backend parts and more.

Describe alternatives you've considered There are no alternatives. I looked at the example code and worked my way through errors and eventually figured it out, but things would be way faster with proper documentation.

Additional context

Georgios1999 avatar Sep 10 '25 17:09 Georgios1999

@Georgios1999 Thanks for the feedback and for sharing your experience! There’s already a start on documentation using GitHub Pages, but it’s pretty basic right now. I’d really appreciate any help improving it! If you’ve got ideas, want to add examples, or just want to make things clearer for others, feel free to jump in. Your contributions would definitely help out beginners.

Let me know if you have any specific suggestions or want to get started, happy to help however I can. Thanks again for offering to help!

https://w-ahmad.github.io/WinUI.TableView/

w-ahmad avatar Sep 11 '25 11:09 w-ahmad

Thanks for letting me know! I just saw the docs folder. I'll make sure to contribute to it once I learn more about TableView and use it effectively in my app to provide examples.

Georgios1999 avatar Sep 11 '25 12:09 Georgios1999

that would be great. for reference you can try the sample app where I added examples with ready to use code snippets.

https://github.com/w-ahmad/WinUI.TableView.SampleApp https://tableview.samples.w-ahmad.dev/ https://apps.microsoft.com/detail/9ntgb6lmjzx3?referrer=appbadge&mode=direct

w-ahmad avatar Sep 11 '25 12:09 w-ahmad

We need to figure some things out before I can start contributing by writing the docs.

I'm awaiting answers for #218 and #220

After this, I can start contributing and I may follow up with any other questions that I may have. I'm already working on the docs (for things I know like XAML properties, quick start guides, etc.) but getting answers for these two Discussions is going to clarify things for all of us.

Georgios1999 avatar Sep 12 '25 18:09 Georgios1999

Thanks for answering the discussions! I am looking at the code you requested to learn more about TableView, and I have started creating the drafts for the docs. If I have any questions, I'll let you know. I'll create a pull request when ready that adds the new docs to the docs folder.

Georgios1999 avatar Sep 13 '25 09:09 Georgios1999

Finally found out how to do ComboBox columns!!

I will update the documentation to make it really simple and easy to read so any user regardless of skill level can use TableView. Expect changes slowly, but I will re-open the pull request soon.

To further avoid messing up with TableView in the near future, I might also make a module to add to your Samples app that simplifies things further.

Thanks for bringing us TableView! It's a lifesaver for WinUI devs like me!

Georgios1999 avatar Sep 16 '25 19:09 Georgios1999

I may or may not have finally found a way to add truly dynamic columns, solving many of the community's questions and greatly adding to the docs, which I've made a mess and honestly need to clear up repo-wise (full of cluttering commits like "Docs V3" then "Docs V3 (final)" and then "Docs V3 (I promise this is the final)" then "Docs V3 (the most final of them all)" and then so on).

I'll keep working on it, see if I can wrap my head around it, and I'll let you know about anything I find useful or necessary in the future.

In the near future (when I can finally finish the final final final... version of the docs), I can also incorporate these in your Samples App.

Again, thanks for bringing TableView to us. Keep contributing to your community ❤️

Georgios1999 avatar Sep 29 '25 17:09 Georgios1999

@w-ahmad, I am working on a major rewrite of the docs and on adding new sections so they can be easily implemented on a website or in your Samples app. Would you like it if I also rewrote the README and introduction to link to the docs and make everything clearer or should I keep the rest as is?

Georgios1999 avatar Oct 05 '25 08:10 Georgios1999

@w-ahmad I think I'm finally done with it! I tried cleaning the commit history but didn't find a way to do that. The pull request is #252 Please check for any mistakes! Thanks!

Georgios1999 avatar Nov 22 '25 11:11 Georgios1999