control-toolbox/OptimalControl.jl

Solve documentation

Open

#305 opened on Aug 20, 2024

View on GitHubContributor guide
 (8 comments) (0 reactions) (3 assignees)Julia (9 forks)auto 404
documentationgood first issue

Repository metrics

Stars
 (132 stars)
PR merge metrics
 (PR metrics pending)

Description

We could add examples with the most common options. Or a list: print_level, tolerances...

Contributor guide

Research direction
Inspect the existing documentation structure and locate where solver options are discussed. Look for examples of common options like print level and tolerances, and plan to add illustrative examples or a list.
Tech stack
julia
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
GitJulia
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75