Skip to content

docs: in-repo Clara documentation (fixes #2312) - #3108

Closed
wyf027 wants to merge 1 commit into
catchorg:develfrom
wyf027:docs/clara-link-own-main-2312
Closed

docs: in-repo Clara documentation (fixes #2312)#3108
wyf027 wants to merge 1 commit into
catchorg:develfrom
wyf027:docs/clara-link-own-main-2312

Conversation

@wyf027

@wyf027 wyf027 commented May 17, 2026

Copy link
Copy Markdown

Summary

Fixes #2312.

Adds docs/clara.md describing the embedded Catch::Clara API and points own-main.md / opensource-users.md at it instead of the archived standalone Clara repository.

Test plan

  • Markdown links only

Clara is developed inside Catch2; link own-main and opensource-users to
docs/clara.md instead of the archived external repository (fixes #2312).
@codecov

codecov Bot commented May 17, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 91.26%. Comparing base (69e0473) to head (3ca196b).

Additional details and impacted files
@@           Coverage Diff           @@
##            devel    #3108   +/-   ##
=======================================
  Coverage   91.26%   91.26%           
=======================================
  Files         204      204           
  Lines        8905     8905           
=======================================
  Hits         8127     8127           
  Misses        778      778           
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@wyf027

wyf027 commented May 26, 2026

Copy link
Copy Markdown
Author

Friendly bump: this PR adds a short in-repo docs/clara.md hub and updates the two stale external Clara links (own-main.md, opensource-users.md) for #2312.

Compared to #3062, this keeps the archived-repo context and links to 232-Cfg-CustomMain.cpp + command-line.md. Happy to rebase or consolidate if maintainers prefer a single approach.

@wyf027

wyf027 commented May 26, 2026

Copy link
Copy Markdown
Author

Friendly bump on #2312 — still open and the external Clara links in own-main.md / opensource-users.md remain stale. This PR is ready for review when you have time.

@wyf027

wyf027 commented May 26, 2026

Copy link
Copy Markdown
Author

Friendly bump — docs-only PR linking Clara usage to in-repo clara.md (Fixes #2312). Ready for review when you have time.

@horenmar horenmar closed this Jun 13, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

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

2 participants