Skip to content

docs: Change of documentation conventions

Janaina Senna requested to merge documentation_conventions into develop

Description

We aim to design and implement the code documentation and specification system and make if efficient so that to reduce developer overhead while ensuring living documentation and specification. For that @kabir.kbr and @0xPravar are working on documentation and specification, while @kabir.kbr build scripts for compiling the documentation into gibook pages automatically. This merge request is a rehash of the documentation conventions agreed with @janaina.senna; For previous work see documentation#23 (comment 1555488965) (old convention) and current work tracked with documentation#100 (closed). Belongs to documentation work package architecture#140

Checklist

  • changed names of README.md to README-USR.md for user documentation (where appropriate);
  • changed names of README-DEV.md to README.md for technical documentation;
  • deleted empty files, previously populated, but not filled with content and not relevant due to DMS refactoring;
  • created CONTRIBUTING.md with guidelines to contribute in NuNet's development by reporting bugs, suggesting improvements, and making code contributions.

Merge request reports