Documentation on wiki

[tukusejssirs]

Create documentation wiki. It should contain (wip):

• [ ] about romcal;
• [ ] installation guide;
• [ ] building guide;
• [ ] usage guide;
• [ ] localisation guide;
  • [ ] how to add a new locale (language);
  • [ ] how to add a new calendar;
  • [ ] how to translate strings;
• [ ] how does it work? (or dev docs)
  • [ ] describe why and what for are the dependencies required;
  • [ ] what is the process of calendar generation;
  • [ ] what is the localisation process (what the app does to output the data in a lang);
• [ ] contribution;
  • [x] Contributor’s Guide;
  • [ ] how to test;
  • [ ] how to report an issue;
  • [ ] how to create a pull request.

[tukusejssirs]

@pejulian, do you have any docs written down? Or everything is in your head only? :)

[tukusejssirs]

If you want the docs in the repo exclusively, we could create docs/ folder and create Markdown files there.

Still I think that the main documentation should be in the Wiki, but I won’t oppose the docs in the repo if you want that. :smiley:

[emagnier]

Wiki is good place for documentation 👍

[tukusejssirs]

Wiki is good place for documentation 👍

@emagnier, do you still agree with this? I have seen you have added some docs into docs/ folder within the repo. Also now I think that the repo is much much better place for the docs, as the docs need to be in sync with romcal version.

[emagnier]

Wiki was a good start, and might be still a good place for things not directly related to romcal (like how to use git) if we want to keep these instructions (although there is already probably plenty and better instructions over the internet).

For everything specific to romcal, having it in the codebase allow to keep versioning (and the right doc for the right version), and will eventually ease the generation of a website (page content generated from these .md files).

[tukusejssirs]

I agree with you.

Wiki was a good start, and might be still a good place for things not directly related to romcal (like how to use git) if we want to keep these instructions (although there is already probably plenty and better instructions over the internet).

You’re right that there are plenty and better instructions on the Internet, however, when we meet a newcomer, we’d like to help him as fast as possible and probably without the need to search the Internet instead of them (they might be lazy, ignorant, or simply lack some experience to do that themselves). Otherwise, yes, non-romcal-related stuff might be out of scope of this project. :smiley:

[emagnier]

I didn't say the opposite. Just that this should stay in the wiki (if we want to keep it) since it's not directly about romcal.