faircode.io docs feedback

[hmenager]

Great work overall folks! 🥳
Here's my suggestions.

OVERALL DOCS

• there is a user documentation, and a developer documentation, but no "contribution" section in the documentation. this section would explain how people can contribute to the project, tell them their how their contribution would be evaluated and included in the repository -> this could be as simple as linking to https://github.com/fairdataihub/codefair-app/blob/main/CONTRIBUTING.md

DEVELOPER DOCS

• minor: add links to Nuxt and Probot websites, so that people who do not know these frameworks know where they are.
• the developer docs tells you how to install the app locally and run the server, but not how to work with is. If I run this locally, how do I interact with the local version and how do I make it interact with a github repository, or a mock of it, for development and test purposes?
• if I want to "add a check", where should I go and how should I do it? a dedicated section could be nice.

[fairdataihub-bot]

Hello! Thank you for opening this issue. Your input is valuable and helps improve the project. Can you please provide a detailed description of the problem you're encountering? Any additional information such as steps to reproduce the issue would be greatly appreciated. Thank you!

[bvhpatel]

@hmenager I added this page for your "Overall docs" comment: https://docs.codefair.io/docs/contributing.html.

There are also links now to Nuxt and Probot: https://docs.codefair.io/app/running-locally.html

We are now working on the last two points. A couple of tutorials for adding a new feature will be added here: https://docs.codefair.io/app/intro-new-feature.html