Editing documentation
You are welcome to edit any page in RiverBench – be it a dataset description, a benchmark task definition, or a documentation page. To do this, simply use the Edit this page button at the top of the page:
It will take you to GitHub, where you will be prompted to fork the repository and create a pull request with your changes.
The documentation pages are written in Markdown. However, some pages like datasets, tasks, and profiles are generated automatically from RDF metadata written in the Turtle language. In that case, you will find a button like this at the top of the page:
Simply edit the values in the metadata file and the documentation will be updated automatically. You can read more about the structure of the metadata in the metadata documentation.
Gotcha!
You cannot edit pages of a stable release of RiverBench (e.g., 2.0.1) – that would make no sense, as the release is immutable. Instead, you can edit the development version of the documentation, which will be included in the next release.
To be able to edit pages, switch to the dev version of the documentation using the version selector in the top navigation bar or by clicking here.
Technical details
The RiverBench website is rendered from Markdown files using MkDocs and lives in the riverbench.github.io repository. Most files there are automatically generated and updated by CI scripts. However, some files are static and can be edited directly.
In the riverbench.github.io repo you can edit:
docs/assets– static assets and imagesdocs/documentation– all files in this directory are static documentation pagesdocs/datasets/index.md– the overview page for datasetsdocs/categories/index.md– the overview page for categoriesdocs/schema/index.md– the overview page for schemas
Editing the homepage and main README
In the doc directory of the main repo you will find the files that are used to build the index page of the website and the main README of the repository. These files are written in Markdown and can be edited directly.