CliMA / CliMA/CalibrateEmulateSample.jl

docs-wide @ref for menitoned methods and structs.

Open
#440 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Julia
Stars
90
Forks
16
PR merge metrics
No merged PRs in 30d

Description

## Issues

Currently we use `@ref` to link between docs page sections etc. but can also be used for documented functions. deploy this docs-wide.

## Possible solution

Seems like a good use case for claude skill `doc-refs`.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by reviewing the repository documentation for existing @ref links between page sections and for documented functions and structs. Apply the @ref treatment docs-wide, then verify that the documentation consistently links mentioned methods and structs.

Written by the indexing model from the issue text.

Assessment

Tech stack
julia
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.