btcven / locha

Communicate with others and broadcast Bitcoin transactions off-grid without internet access or even power grid.
https://locha.io
Apache License 2.0
294 stars 37 forks source link

One file per chapter. #39

Closed luisan00 closed 4 years ago

luisan00 commented 4 years ago

The problem:

One file for all the documentation will be a huge problem for many reviewers, for example a simple PR can be a headache.

Solution:

Break the document into chapters, this way each chapter will be a document. this will facilitate the reviews and PRs

Keep in mind:

For future translations to other languages, the name of the files will be language agnostic. For example, each chapter can be named _chapter1.md for the chapter "one", _chapter2.md for chapter "two", and so.

rdymac commented 4 years ago

chapter_1.md for the chapter "one", chapter_2.md for chapter "two"

I second this suggestion of using more generic names for the files according to its content. If a file has sub content, it could still use the same format: chapter_6_4.md for the 6.4 point of the 6th chapter if it is too long by itself to be in just one file. chapter_6-6-3.md , chapter_6_4.md , chapter_6_5-6_9.md

gustavosinbandera1 commented 4 years ago

for now I have created this branch to show you how the document looks, just let me know if really we need to change the name for each file or maybe with the actual name file could work.

https://github.com/btcven/locha/tree/feature/slice_docummentation/documentation/ES

luisan00 commented 4 years ago

Yes the file names will be chapter_1.md, chapter_2.md, etc or chapter_32.md for sub-chapters, so the naming rules are; **chapter[chapternumber][sub-chapter_number].md**

gustavosinbandera1 commented 4 years ago

this is ready now