We currently have several sources of information distributed in PaNET, which also means twice the effort for maintenance.
- general information in README.md and also in docs/index.html
- details for contributions in CONTRIBUTING.md and docs/std_op_proc.html
- details on workflow in README.md and docs/workflow
As far as I know, some of the files (e.g. README and CONTRIBUTING) must be located in root to be recognized by the system regarding the Community Standards.
We are currently in the process to use jekyll for the generation of the documentation pages. Jekyll can build on html AND md documents. We could focus on working on the original md files in root and create softlinks in docs. This reduces the maintenance effort and still allows to use the information in two different places with minimal effort.
We currently have several sources of information distributed in PaNET, which also means twice the effort for maintenance.
As far as I know, some of the files (e.g. README and CONTRIBUTING) must be located in root to be recognized by the system regarding the Community Standards.
We are currently in the process to use jekyll for the generation of the documentation pages. Jekyll can build on html AND md documents. We could focus on working on the original md files in root and create softlinks in docs. This reduces the maintenance effort and still allows to use the information in two different places with minimal effort.