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

How can documentation be improved? #50

Closed
vlovgr opened this Issue Oct 12, 2017 · 5 comments

Comments

2 participants
@vlovgr
Owner

vlovgr commented Oct 12, 2017

  • Is the intent and motivation behind Ciris clear and easy to understand?
  • Is there anything unclear or that could be improved in the usage guide?
  • Have you found anything that could improve the contributing guide?
  • What would you like to change about the release notes?
  • Anything that could improve the API documentation?
  • What's missing from the readme?
@marthall

This comment has been minimized.

Show comment
Hide comment
@marthall

marthall Feb 21, 2018

Hi @vlovgr
Love this project, and I'm adopting it to our project. However, I have some suggestions on the documentation.

The usage guides are nice, but there is quite a big gap from them to the API. I miss some example apps which ties everything together. Would it be possible to add an example somewhere in the library? Like a template.

Look forward to hear from you :)

marthall commented Feb 21, 2018

Hi @vlovgr
Love this project, and I'm adopting it to our project. However, I have some suggestions on the documentation.

The usage guides are nice, but there is quite a big gap from them to the API. I miss some example apps which ties everything together. Would it be possible to add an example somewhere in the library? Like a template.

Look forward to hear from you :)

@vlovgr

This comment has been minimized.

Show comment
Hide comment
@vlovgr

vlovgr Feb 21, 2018

Owner

Hi @marthall! Thanks for your feedback! I'm currently in the process of rewriting and improving the documentation, and will definitely take your input into consideration.

The usage guides are nice, but there is quite a big gap from them to the API.

Completely agree, and this is one of the reasons why I'm rewriting the documentation.

I miss some example apps which ties everything together.

The new documentation hopefully does a better job at explaining this, but I think creating a separate repository with a small example application is also a great idea.

Owner

vlovgr commented Feb 21, 2018

Hi @marthall! Thanks for your feedback! I'm currently in the process of rewriting and improving the documentation, and will definitely take your input into consideration.

The usage guides are nice, but there is quite a big gap from them to the API.

Completely agree, and this is one of the reasons why I'm rewriting the documentation.

I miss some example apps which ties everything together.

The new documentation hopefully does a better job at explaining this, but I think creating a separate repository with a small example application is also a great idea.

@vlovgr

This comment has been minimized.

Show comment
Hide comment
@vlovgr

vlovgr Mar 12, 2018

Owner

@marthall The updated usage guide is now live at https://cir.is/docs and the release notes roughly explain what's changed: https://github.com/vlovgr/ciris/releases. The usage guide now goes into more depth, and directly links to the API documentation where relevant. Hopefully this somewhat bridges the gap between the API and the usage guide.

Owner

vlovgr commented Mar 12, 2018

@marthall The updated usage guide is now live at https://cir.is/docs and the release notes roughly explain what's changed: https://github.com/vlovgr/ciris/releases. The usage guide now goes into more depth, and directly links to the API documentation where relevant. Hopefully this somewhat bridges the gap between the API and the usage guide.

@marthall

This comment has been minimized.

Show comment
Hide comment
@marthall

marthall Mar 12, 2018

@vlovgr That's really good! Thanks for fast reply and fix 👍

I'll check it out later this week :)

marthall commented Mar 12, 2018

@vlovgr That's really good! Thanks for fast reply and fix 👍

I'll check it out later this week :)

@vlovgr

This comment has been minimized.

Show comment
Hide comment
@vlovgr

vlovgr Mar 29, 2018

Owner

@marthall there's now a small example application here: https://github.com/vlovgr/ciris-example

Owner

vlovgr commented Mar 29, 2018

@marthall there's now a small example application here: https://github.com/vlovgr/ciris-example

@vlovgr vlovgr closed this Sep 6, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment