Skip to content

Docs: move documentation to README#1292

Open
ohmyfelix wants to merge 1 commit into
contributte:masterfrom
ohmyfelix:chore/promote-docs-readme
Open

Docs: move documentation to README#1292
ohmyfelix wants to merge 1 commit into
contributte:masterfrom
ohmyfelix:chore/promote-docs-readme

Conversation

@ohmyfelix

Copy link
Copy Markdown
Contributor

What changed

  • Moved the documentation index from .docs/README.md into the root README.md.
  • Reworked the root README order to match the Contributte README style with versions and installation early.
  • Updated documentation links to point at .docs/*.md from the root README.

Why

Refs contributte/contributte#75.

Testing

  • git diff --check
  • Targeted README scans for duplicate headings, stale .docs/README links, and moved .docs/*.md links.

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

codecov Bot commented Jul 4, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 48.77%. Comparing base (d9144ab) to head (ff824ac).

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #1292   +/-   ##
=======================================
  Coverage   48.77%   48.77%           
=======================================
  Files          61       61           
  Lines        2901     2901           
=======================================
  Hits         1415     1415           
  Misses       1486     1486           

☔ 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.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

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