Skip to content

Editing documentation

A large chunk of RiverBench's documentation is automatically generated from the metadata – see the metadata documentation for more details. However, lots of pages are static or include static content. This page explains how to edit them.

Editing static pages

Static pages are written in Markdown and live in the riverbench.github.io repository. To edit them, simply open a pull request to that repository.

Warning

Some pages in the riverbench.github.io repository are generated automatically. Do not edit them directly, as your changes will be either overwritten or will make something go seriously wrong. Instead, edit the metadata files, as described in the metadata documentation.

In the riverbench.github.io repo you can edit:

  • docs/assets – static assets and images
  • docs/documentation – all files in this directory are static documentation pages
  • docs/datasets/index.md – the overview page for datasets
  • docs/profiles/index.md – the overview page for profiles
  • docs/schema/index.md – the overview page for schemas

And that's it. The rest of the pages are generated automatically.

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.