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++ (20,381 stars) (3,228 forks)batch import
DocumentationGood First Issue

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

Tech stack
cpp
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.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic knowledge of MarkdownFamiliarity with Catch2's docs structure
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90
Research direction
Locate the file `docs/own main.md` in the repository. Find the line that links to Clara's repository. Determine where to create a new documentation page for Clara (likely `docs/clara.md`). Update the link to point to the new page. Ensure the new page contains appropriate documentation for the Clara parser as used within Catch2.
Replace link to Clara's repository for doc with our own documentation page · catchorg/Catch2#2312 | Good First Issue