Skip to content

Break the README into docs pages, remove the CLI ref from the README#898

Merged
nathanjmcdougall merged 8 commits intomainfrom
887-create-an-introduction-page-in-the-docs
Jul 23, 2025
Merged

Break the README into docs pages, remove the CLI ref from the README#898
nathanjmcdougall merged 8 commits intomainfrom
887-create-an-introduction-page-in-the-docs

Conversation

@nathanjmcdougall
Copy link
Copy Markdown
Collaborator

There's a test that keeps these in sync.

@codecov
Copy link
Copy Markdown

codecov bot commented Jul 23, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

✅ All tests successful. No failed tests found.

📢 Thoughts on this report? Let us know!

@codspeed-hq
Copy link
Copy Markdown

codspeed-hq bot commented Jul 23, 2025

CodSpeed Instrumentation Performance Report

Merging #898 will not alter performance

Comparing 887-create-an-introduction-page-in-the-docs (34065f9) with main (c834bf7)1

Summary

✅ 2 untouched benchmarks

Footnotes

  1. No successful run was found on main (90fa657) during the generation of this report, so c834bf7 was used instead as the comparison base. There might be some changes unrelated to this pull request in this report.

@nathanjmcdougall nathanjmcdougall merged commit 39206d3 into main Jul 23, 2025
20 checks passed
@nathanjmcdougall nathanjmcdougall deleted the 887-create-an-introduction-page-in-the-docs branch July 23, 2025 05:14
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.

Create quick start guide in docs Create an introduction page in the docs Move CLI reference to the mkdocs page from README

1 participant