Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: overhauled docs #895

Merged
merged 9 commits into from
Sep 30, 2023
Merged

docs: overhauled docs #895

merged 9 commits into from
Sep 30, 2023

Conversation

JoshuaKGoldberg
Copy link
Owner

@JoshuaKGoldberg JoshuaKGoldberg commented Sep 29, 2023

PR Checklist

Overview

Streamlines the flow of how devs will likely read through the docs. Most notably, adds a big docs/Tooling.md with a table explicitly describing what all the tooling pieces are.

@codecov
Copy link

codecov bot commented Sep 29, 2023

Codecov Report

Merging #895 (195dcbf) into main (4486186) will increase coverage by 11.34%.
Report is 2 commits behind head on main.
The diff coverage is 94.16%.

@@             Coverage Diff             @@
##             main     #895       +/-   ##
===========================================
+ Coverage   82.19%   93.54%   +11.34%     
===========================================
  Files          84       90        +6     
  Lines        4612     4726      +114     
  Branches      214      374      +160     
===========================================
+ Hits         3791     4421      +630     
+ Misses        817      304      -513     
+ Partials        4        1        -3     
Flag Coverage Δ
create 72.03% <94.16%> (+0.06%) ⬆️
initialize 37.18% <94.16%> (+0.11%) ⬆️
migrate 70.78% <94.16%> (+0.02%) ⬆️
unit 67.25% <94.16%> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

Files Coverage Δ
src/shared/options/exclusionDescriptions.ts 100.00% <100.00%> (ø)
src/shared/options/augmentOptionsWithExcludes.ts 43.58% <30.00%> (-17.19%) ⬇️

... and 46 files with indirect coverage changes

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@JoshuaKGoldberg JoshuaKGoldberg marked this pull request as ready for review September 30, 2023 11:28
@JoshuaKGoldberg JoshuaKGoldberg merged commit 6541f8e into main Sep 30, 2023
@JoshuaKGoldberg JoshuaKGoldberg deleted the overhaul-docs branch September 30, 2023 13:06
@github-actions
Copy link

github-actions bot commented Oct 2, 2023

🎉 This is included in version v1.32.0 🎉

The release is available on:

Cheers! 📦🚀

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.

📝 Documentation: Rework README.md and docs/
1 participant