Initiate a contribute page to online documentation #116
Conversation
|
I think it is a good idea to have named it contribute. It might therefore be the opportunity to describe briefly the various tools that are run of a PR and describe what are the best practices to run some of those tools locally before committing. What do you think ? |
1 similar comment
|
I think it is a good idea to have named it contribute. It might therefore be the opportunity to describe briefly the various tools that are run of a PR and describe what are the best practices to run some of those tools locally before committing. What do you think ? |
|
Exactly, that's the idea. Even though it is not yet the case, we should add later stuff about good practice for PRs. |
7634f3c to
de6dc1d
Compare
|
Can you please add a preview ? I think adding a part on how to check code with linters locally is a must since we have it now. @dbarbier can you please add something ? |
It will be simpler for me to make a PR after this one is merged. |
- a link is available in top-left menu - it give info about - installation from source in dev mode - local build of the docs - notebooks convention to extract title and description - unit tests - it still misses guidelines about how to actually contribute
de6dc1d to
d3aef9a
Compare
You mean a screenshot of resulting doc ? Here you are:
For full doc, download the artifact named "doc" from the workflow triggered by this PR, then mkdir testdoc
cd testdoc
unzip path/to/doc.zip -d scikit-decide
python -m http.server |
For now, it still misses guidelines about how to actually contribute.
So next steps (for further PRs) could be