scravy
commented
6 years ago This is related to https://github.com/dtr-org/unit-e/issues/146
There are certain documents which we probably do want to own and not keep sync with bitcoin with.
The document has a CONTRIBUTING and README, but (especially the README) they need a good overhaul (not just because of identifiers, I do think the bitcoin README could be a lot better, while the CONTRIBUTING document and process are quite nice actually).
cornelius
Create a list of the most important documentation we need so that we can decide where to put out and how to write it.
Two central locations are the README.md and the CONTRIBUTING.md file. These will be entry points for many people looking at the open source project.
It's probably best to keep the documentation in the git repositories we have for now so that it's close to the code and we can follow the same procedures for reviewing and editing.
For user documentation ReadTheDocs is a service which is very simple to use. That could be a good start. Jekyll also might be a good choice if we want to host the documentation ourselves.
We will need some professional writers to help with the documentation, to write parts, but probably even more important to help with keeping a good structure and language and to help with enabling more people to contribute.
Actively gathering feedback on the docs is very import, so we can make sure it serves its purpose in helping developers and users to get involved with our project.