catchorg/Catch2

Replace link to Clara's repository for doc with our own documentation page

Open

#2,312 opened on Oct 27, 2021

View on GitHub
 (6 comments) (0 reactions) (0 assignees)C++ (3,228 forks)batch import
DocumentationGood First Issue

Repository metrics

Stars
 (20,381 stars)
PR merge metrics
 (Avg merge 1d 8h) (1 merged PR in 30d)

Description

Clara, the command line parser library in Catch2, stopped being a separate project from Catch2 about 3 years ago. Since then it was only developed inside Catch2, while the original upstream repository was made inactive and archived.

Given that Clara-inside-Catch2 has also slowly diverged from the separate version, we should provide its documentation inside the Catch2 repo, and replace the link to upstream docs in the own-main docs with link to our own documentation page for Clara.

Contributor guide

Research direction
Locate the file 'docs/own main.md' in the repository, find the link to Clara's external repository, and replace it with a link to the Clara documentation page within the Catch2 documentation.
Tech stack
None
Domain
documentationbackend
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90