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 and examples #73

Open
conficient opened this issue Jan 21, 2020 · 1 comment
Open

Documentation and examples #73

conficient opened this issue Jan 21, 2020 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@conficient
Copy link
Collaborator

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.

@IvanJosipovic
Copy link
Owner

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 IvanJosipovic added the documentation Improvements or additions to documentation label Mar 22, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants