Skip to content

Docs: move documentation to README - #19

Open
ohmyfelix wants to merge 2 commits into
contributte:masterfrom
ohmyfelix:chore/promote-docs-readme
Open

Docs: move documentation to README#19
ohmyfelix wants to merge 2 commits into
contributte:masterfrom
ohmyfelix:chore/promote-docs-readme

Conversation

@ohmyfelix

Copy link
Copy Markdown
Contributor

What changed

  • Moved the package documentation from .docs/README.md into the root README.md.
  • Removed the obsolete .docs/README.md pointer target.
  • Kept the Contributte badge/contact scaffold and promoted Versions before installation.

Why

Refs contributte/contributte#75

Testing

  • git diff --check

Co-authored-by: Felix <rkfelix@gmail.com>
@codecov

codecov Bot commented Jun 22, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 34.18%. Comparing base (47de678) to head (a425674).

Additional details and impacted files
@@           Coverage Diff           @@
##           master      #19   +/-   ##
=======================================
  Coverage   34.18%   34.18%           
=======================================
  Files           3        3           
  Lines         117      117           
=======================================
  Hits           40       40           
  Misses         77       77           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Co-authored-by: Felix <felix@contributte.org>
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.

1 participant