Prism: Prioritize documentation updates

Created on 1 May 2018  路  5Comments  路  Source: PrismLibrary/Prism

Description

The provided current documentation http://prismlibrary.github.io/docs/ for the Prism library is quite small and getting outdated. We need to fish information crumbs from release notes and blog posts from different locations. Please consider to prioritize documentation tasks because many people are trying to use your great library based on the docs.

Thanks

help wanted

Most helpful comment

@totht91 I totally agree with you that the docs need to be updated. The good news is that they are also open source and we accept PR's. Please feel free to fish away from the release notes and send us a PR 馃憤
https://github.com/PrismLibrary/Prism-Documentation

All 5 comments

@totht91 I totally agree with you that the docs need to be updated. The good news is that they are also open source and we accept PR's. Please feel free to fish away from the release notes and send us a PR 馃憤
https://github.com/PrismLibrary/Prism-Documentation

You may have noticed that I've added the help wanted label to this issue. There is only so much time in my day. If there is an issue you feel needs updating in our docs, please send us a PR. We do have a CI/CD pipeline setup for this so all updates in our Documentation repo are reflected within a few minutes in the docs.

@totht91 @dansiegel What articles would you say are in the most dire need of updating, or adding? I'm making an app with Prism but I'm largely feeling my way through it so my information might not be best practice, but it would contribute to getting an app built.

I might write an article about dependency injection within the context of Prism to see if my writing style is well understood etc and submit a PR.

I am closing this as we do not need an issue to remind us that our docs are way out of date :)

We'll get there.... eventually.

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.

Was this page helpful?
0 / 5 - 0 ratings

Related issues

joacar picture joacar  路  6Comments

tiagodenoronha picture tiagodenoronha  路  4Comments

topfunet picture topfunet  路  5Comments

brianlagunas picture brianlagunas  路  3Comments

JaggerJo picture JaggerJo  路  3Comments