Skip to content

Docs: move documentation to README#112

Merged
trejjam merged 1 commit into
contributte:masterfrom
ohmyfelix:chore/promote-docs-readme
Jun 23, 2026
Merged

Docs: move documentation to README#112
trejjam merged 1 commit into
contributte:masterfrom
ohmyfelix:chore/promote-docs-readme

Conversation

@ohmyfelix

Copy link
Copy Markdown
Contributor

What changed

  • Moved package documentation from .docs/README.md into the root README.md.
  • Kept the Contributte badge/contact scaffold and added a concise package intro, versions table, contents, and usage/configuration sections.
  • Removed the obsolete .docs/README.md wrapper source.

Why

Refs contributte/contributte#75

Testing

  • git diff --check
  • Targeted README scans for duplicate headings, stale local .docs links/images, and ToC anchors.

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.
⚠️ Please upload report for BASE (master@55fee68). Learn more about missing BASE report.

Additional details and impacted files
@@            Coverage Diff             @@
##             master      #112   +/-   ##
==========================================
  Coverage          ?   100.00%           
==========================================
  Files             ?         2           
  Lines             ?        33           
  Branches          ?         0           
==========================================
  Hits              ?        33           
  Misses            ?         0           
  Partials          ?         0           

☔ 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.

@trejjam trejjam merged commit 7286a92 into contributte:master Jun 23, 2026
9 checks passed
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.

2 participants