BlazorTable icon indicating copy to clipboard operation
BlazorTable copied to clipboard

Documentation and examples

Open conficient opened this issue 5 years ago • 1 comments

Do we need to consider the structure of the examples and documentation? I noticed you separated the code samples app into a "Shared" project, and then added Server and WASM versions - that was a good idea.

Samples

When I added EmptyDataTemplate I added an example page, EmptyData.razor, but that could lead a very cluttered Pages folder. Perhaps we could add a Features folder to the sample app, and have a page per-feature inside that folder?

Documentation

I did want to add a documentation page for the new feature, but wasn't sure where to do this. We could use the Wiki on Github but I don't think that supports pull requests? Or perhaps just add a /docs/ folder to the source, with markdown content, and refer to a table on contents from the main ReadMe.md ?

Happy to sort this out if you're agreeable.

conficient avatar Jan 21 '20 11:01 conficient

Thank you for taking the interest in this, your help is much appreciated.

I haven't thought much about the documentation apart from what I have so far.

I like your suggestion of the /docs/ folder and links in the Readme.md.

The question that I have is, what do we document in Github markdown vs in the sample app?

I personally prefer the live examples in the sample app, however, they may be missed by some.

We could also use https://chanan.github.io/BlazorPrettyCode to help with the code formatting.

On a related note, I definitely need to start a changelog.md. I'll write one on the next release.

IvanJosipovic avatar Jan 29 '20 01:01 IvanJosipovic