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

Best place for code samples featuring controls ? #194

Closed
hugoabernier opened this issue Dec 4, 2018 · 2 comments
Closed

Best place for code samples featuring controls ? #194

hugoabernier opened this issue Dec 4, 2018 · 2 comments

Comments

@hugoabernier
Copy link
Contributor

hugoabernier commented Dec 4, 2018

Category

[ ] Enhancement

[ ] Bug

[x ] Question

I have recently submitted a PR for a Chart control (RE: issue #15 ). I created documentation for the control by copying the structure of the other .MD files, but I'd like to provide more samples (e.g.: how to use each type of chart, how to use events, how to use plugins, etc.).

What would be the best approach in your opinion?

  • Add content to the main documentation page for my control
  • Add samples on different pages (even though no other control seem to use more than one MD file)
  • Create a full sample solution and documentation and post it on sp-dev-fx-webparts
  • Don't bother with documentation -- documentation is boring

Your advice is greatly appreciated.

Thanks!

@estruyf
Copy link
Member

estruyf commented Dec 7, 2018

Feel free to create a Chart Control MD file per sample, I will map them underneath the main Chart Control navigation item.

@hugoabernier
Copy link
Contributor Author

@estruyf Awesome! Will do that.

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