MetOffice / MetOffice/ANTS

Rationalise links to CF in ANTS

Open
#60 0 comments 0 reactions 0 assignees View on GitHub
📚 documentation
Dominant language
Python
Stars
7
Forks
10
Avg merge
1d 19h
Merged PRs (30d)
5

Description

# 📚 Documentation Request

## Addition
We need a consistent method to link to CF conventions throughout ANTS docs. In particular, we want to:

1. Always link to the latest version
2. Link to specific sections

In particular, the usage in the time appendix (appendix A) should be cleaned up - ideally, the definition of the link to CF should be migrated from this appendix over to `docs/source/conf.py`.

Contributor guide

Open the contributing guide

Research direction

Start by inspecting the CF links in the time appendix (Appendix A) and the documentation configuration at docs/source/conf.py. Identify how the CF definition is currently handled, then make links consistently target the latest version and specific sections. Done means the appendix uses the shared definition and all relevant CF links are consistent.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
50/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.