Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[solidago] init docs content and use mkdocs to build docs pages #1972

Draft
wants to merge 12 commits into
base: main
Choose a base branch
from

Conversation

amatissart
Copy link
Member

@amatissart amatissart commented May 16, 2024

Description

Initialize documentation website for Solidago.
The current state is visible on https://solidago.tournesol.app/

Using:

Checklist

  • I added the related issue(s) id in the related issues section (if any)
    • if not, delete the related issues section
  • I described my changes and my decisions in the PR description
  • I read the development guidelines of the CONTRIBUTING.md
  • The tests pass and have been updated if relevant
  • The code quality check pass

@GresilleSiffle GresilleSiffle added the Solidago Tournesol algorithms library label May 23, 2024
@amatissart amatissart force-pushed the solidago-pipeline-docs-1 branch from dde4c9f to 3483609 Compare June 1, 2024 17:53
Base automatically changed from solidago-pipeline-docs-1 to neurips24 June 3, 2024 06:57
Base automatically changed from neurips24 to main October 24, 2024 09:41
lenhoanglnh and others added 7 commits December 19, 2024 14:30
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.
@amatissart
Copy link
Member Author

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 mkdocs gh-deploy but that could also be included in the CI workflows.

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?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Solidago Tournesol algorithms library
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants