[solidago] init docs content and use mkdocs to build docs pages#1972
[solidago] init docs content and use mkdocs to build docs pages#1972amatissart merged 24 commits intomainfrom
Conversation
dde4c9f to
3483609
Compare
7e1d811 to
ea3b0a0
Compare
ea3b0a0 to
5a65c95
Compare
|
I configured a CNAME DNS record in order to deploy the docs to a custom with Github Pages. For now it needs to be pushed manually with The current state is visible on https://solidago.tournesol.app It's still missing quite a lot of docstrings, it needs a little more polish here and there, and more examples would also be helpful. @lenhoanglnh What is your opinion about the structure of the docs? Are there specific sections to create in order to help onboard researchers? |
Fixed tiny_tournesol.zip file for testing. Added data_analysis for dataset submission. WIP Runtime error on icml24 experiments to be fixed
…than additional term. This implies that the addition of a new user with huge uncertainties will not affect the quantile much.
…ves and data structures
5c46e8b to
f9be9c0
Compare
cbc0a1d to
2b7e4c1
Compare
|
I think this PR is ready to be merged now. The docs are visible on https://solidago.tournesol.app/ @GresilleSiffle @lenhoanglnh Do you want to have a look before I merge? |
|
It looks very good to me @amatissart 👌 Feel free to merge when you want, maybe after a review from @lenhoanglnh In the future the Get Started page could benefit from more paragraphs, to help the users understand what are the goals of Solidago and in which context the library is relevant. If I understood correctly, this PR is the initial set-up of the documentation, not an effort to document everything exhaustively right? Very minor for now: some functions use a prescriptive form of docstring, as recommended by PEP257 (like "Standardize scores..."), whereas other use a descriptive form (like "Aggregates the scores..."). We could decide which form we want to use in the doc. |
|
An idea: we could add a link to the documentation in the footer of the front end, under the section Research. |
Done in 5d93da4 |
Description
Initialize documentation website for Solidago.
The current state is visible on https://solidago.tournesol.app/
Using:
Checklist