Research Cockpit Playbook

This repository holds the Research Cockpit Playbook, published as a website built with MkDocs and the Material theme, and deployed to GitHub Pages on every push to main.

• Live site: https://tue-rdi.github.io/Research-Cockpit-Playbook/
• Source repository: https://github.com/TUE-RDI/Research-Cockpit-Playbook

Repository layout

docs/                   Markdown sources for the site
  index.md              Overview (site home)
  RESEARCH_COCKPIT_PLAYBOOK.md   The playbook itself
mkdocs.yml              Site configuration
requirements.txt        Python dependencies (MkDocs + theme)
.github/workflows/      GitHub Actions workflow for Pages deploy

Local preview

pip install -r requirements.txt
mkdocs serve

Then open http://localhost:8000.

Publishing

Pushes to main trigger .github/workflows/deploy.yml, which builds the site with mkdocs build, uploads the site/ output as a Pages artifact, and deploys it via actions/deploy-pages. In the repository's Settings → Pages, the source must be set to GitHub Actions.

Contributions

Feedback, input, and questions are welcome via issues on this repository.