config.yaml

#------------------------------------------------------------
# Values for this lesson.
#------------------------------------------------------------

# Which carpentry is this (swc, dc, lc, or cp)?
# swc: Software Carpentry
# dc: Data Carpentry
# lc: Library Carpentry
# cp: Carpentries (to use for instructor training for instance)
# incubator: The Carpentries Incubator
carpentry: 'incubator'

# Overall title for pages.
title: 'Research Software Documentation'

# Date the lesson was created (YYYY-MM-DD, this is empty by default)
created: '2024-05-20'

# Comma-separated list of keywords for the lesson
keywords: 'software documentation, docstrings, type hints, user guide, technical documentation, architecture documentation, reproducibility, accessibility, collaboration, open science'

# Life cycle stage of the lesson
# possible values: pre-alpha, alpha, beta, stable
life_cycle: 'beta'

# License of the lesson materials (recommended CC-BY 4.0)
license: 'CC-BY 4.0'

# Link to the source repository for this lesson
source: 'https://github.com/FAIR2-for-research-software/Documentation'

# Default branch of your lesson
branch: 'main'

# Who to contact if there are any issues
contact: 'research-it@sheffield.ac.uk'

# Navigation ------------------------------------------------
#
# Use the following menu items to specify the order of
# individual pages in each dropdown section. Leave blank to
# include all pages in the folder.
#

# Order of episodes in your lesson
episodes:
- introduction.md
- readmes.md
- docstrings.md
- readable.md
- contributors.md
- sites.md
- cli.md

# Information for Learners
learners:

# Information for Instructors
instructors:

# Learner Profiles
profiles:

# Customisation ---------------------------------------------
#
# This space below is where custom yaml items (e.g. pinning
# sandpaper and varnish versions) should live

varnish: RSE-Sheffield/uos-varnish@main