You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cordova.apache.org by GitBox <gi...@apache.org> on 2020/03/17 15:26:12 UTC
[GitHub] [cordova-docs] brodybits commented on issue #1057: RFP update and
overhaul cordova-docs
brodybits commented on issue #1057: RFP update and overhaul cordova-docs
URL: https://github.com/apache/cordova-docs/issues/1057#issuecomment-600132600
I have some more thoughts on this:
- I think we need to update all documentation, including plugins & documentation for contributors and maintainers.
- There may be quite a bit of investigation, testing, and interactive discussion needed to get it right.
- I think it would be ideal if we could include efforts to verify that all existing and updated documentation reflects the actual behavior.
- This kind of project should be done in an agile manner, with limited sprints starting with limited pilot phases, to avoid the risk of waste on incorrect priorities.
- Domain experts, ideally multiple Cordova maintainers, would be needed to help ensure we get this right.
JSDoc does seem to be the most well-known, stable, and JavaScript documentation system. I have seen some other nice frameworks such as gitbook and Docusaurus, recall seeing at least one case of maintainers just dropping support.
I am also thinking this would be the perfect time for us to get the ball rolling, before an economic recovery leads to higher costs and more limited expert availability.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@cordova.apache.org
For additional commands, e-mail: commits-help@cordova.apache.org