MetOffice / MetOffice/CSET

Document pre-written recipes in web documentation

Open
#1,234 1 comment 2 reactions 0 assignees View on GitHub
documentation enhancement
Dominant language
Python
Stars
33
Forks
19
Avg merge
1d 22h
Merged PRs (30d)
30

Description

### What problem does your feature request solve?

The recipes included in CSET are not documented. They should be.

### Describe the solution you'd like

The bundled recipes should be in the reference section of the documentation. This section should be automatically generated from the recipes to ensure it stays up-to-date.

### Describe alternatives you've considered

Recipes currently can be viewed via `cset cookbook --details`, but it would be nicer to have them in the web documentation.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by inspecting the bundled recipes and the web documentation's reference section, then compare their content with `cset cookbook --details`. Determine how the reference pages are currently built and make the recipe documentation automatically reflect the bundled recipes; done means the recipes appear in the web reference and stay up to date.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.