Skip to content

First version of consolidated documentation#1008

Merged
benjelloun merged 1 commit into
mainfrom
mkdocs
May 21, 2026
Merged

First version of consolidated documentation#1008
benjelloun merged 1 commit into
mainfrom
mkdocs

Conversation

@joaquinvanschoren
Copy link
Copy Markdown
Contributor

@joaquinvanschoren joaquinvanschoren commented Feb 4, 2026

This PR creates a documentation website that consolidates the different pieces of documentation into a single website, based on MkDocs.

Screenshot 2026-02-04 at 19 13 27

Next steps:

After that, incremental updates can be made, for instance:

  • Adding additional extensions (bio, geo)
  • Adding example datasets described in Croissant
  • Adding a page with example use cases
  • Adding an API reference for the mlcroissant library

@joaquinvanschoren joaquinvanschoren requested a review from a team as a code owner February 4, 2026 18:23
@github-actions
Copy link
Copy Markdown

github-actions Bot commented Feb 4, 2026

MLCommons CLA bot All contributors have signed the MLCommons CLA ✍️ ✅

@joaquinvanschoren
Copy link
Copy Markdown
Contributor Author

@mlcommons/wg-croissant @benjelloun Can this be reviewed? Thanks!

Copy link
Copy Markdown
Contributor

@benjelloun benjelloun left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry for the very late review!

Comment thread mkdocs.yml
- 'Croissant v1.0': croissant-spec-1.0.md
- Extensions:
- 'Responsible AI (RAI)': croissant-rai-spec.md

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you add a section for example "datasets" that links to datasets/index.html ? (That's the generated gallery.)

Comment thread mkdocs.yml
- 'Online Validator': health/croissant-validator-neurips/README.md
- 'Croissant RDF': croissant-rdf/README.md

- Eclair:
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should Eclair be under tools? Maybe the first one? Also update with the new tools?

@benjelloun benjelloun merged commit a1707ce into main May 21, 2026
12 checks passed
@github-actions github-actions Bot locked and limited conversation to collaborators May 21, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants