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 suggestions #36

Open
3 of 6 tasks
zephraph opened this issue Apr 25, 2020 · 4 comments
Open
3 of 6 tasks

Documentation suggestions #36

zephraph opened this issue Apr 25, 2020 · 4 comments
Labels
documentation Improvements or additions to documentation

Comments

@zephraph
Copy link
Contributor

zephraph commented Apr 25, 2020

As I'm going through and creating a basic site today, there are a few places I think the documentation could be improved in.

  • Document comment syntax
  • Modules are shown, but never really talked about themselves. A brief introduction to them wouldn't hurt.
  • Document the use of children in the properties page
  • There's a lot of basic things that would be nice to have documented like making an http call
  • The API for writing a provider
  • Basic file structure recommendations
@Sija Sija added the documentation Improvements or additions to documentation label Apr 25, 2020
@gdotdesign
Copy link
Member

I've did some of these in the 0.10.0 release:

@zephraph
Copy link
Contributor Author

Amazing, thanks!

@gdotdesign gdotdesign reopened this Sep 13, 2020
@gdotdesign
Copy link
Member

Reopened to track the others 😃

@jgarte
Copy link

jgarte commented Mar 9, 2021

See #73 Let me know if I should move it here.

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

4 participants