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.

Sign up for GitHub

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

Jump to bottom

📝 Documentation: Rework README.md and docs/ #856

Closed
2 tasks done
JoshuaKGoldberg opened this issue Sep 21, 2023 · 1 comment · Fixed by #895
Closed
2 tasks done

📝 Documentation: Rework README.md and docs/ #856

JoshuaKGoldberg opened this issue Sep 21, 2023 · 1 comment · Fixed by #895
Assignees
@JoshuaKGoldberg
Labels
area: documentation Improvements or additions to docs status: accepting prs Please, send a pull request to resolve this!
Milestone
Post-Rename Migra...

Comments

@JoshuaKGoldberg
Copy link
Owner

Bug Report Checklist

Overview

I don't think the README.md does a very good job of walking a new person through what this repo is or how to use it. I'll overhaul it this month!

Additional Info

No response
@JoshuaKGoldberg JoshuaKGoldberg added area: documentation Improvements or additions to docs status: accepting prs Please, send a pull request to resolve this! labels Sep 21, 2023
@JoshuaKGoldberg JoshuaKGoldberg added this to the Post-Rename Migration milestone Sep 21, 2023
@JoshuaKGoldberg JoshuaKGoldberg self-assigned this Sep 21, 2023
@JoshuaKGoldberg JoshuaKGoldberg mentioned this issue Sep 29, 2023
Merged
3 tasks
JoshuaKGoldberg added a commit that referenced this issue Sep 30, 2023
@JoshuaKGoldberg
docs: overhauled docs (#895)
6541f8e 
## PR Checklist

- [x] Addresses an existing open issue: fixes #856
- [x] That issue was marked as [`status: accepting
prs`](https://github.com/JoshuaKGoldberg/create-typescript-app/issues?q=is%3Aopen+is%3Aissue+label%3A%22status%3A+accepting+prs%22)
- [x] Steps in
[CONTRIBUTING.md](https://github.com/JoshuaKGoldberg/create-typescript-app/blob/main/.github/CONTRIBUTING.md)
were taken

## 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.
@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
Assignees

@JoshuaKGoldberg JoshuaKGoldberg

Labels
area: documentation Improvements or additions to docs status: accepting prs Please, send a pull request to resolve this!
Projects
None yet
Milestone
Post-Rename Migration
Development

Successfully merging a pull request may close this issue.

docs: overhauled docs JoshuaKGoldberg/create-typescript-app
1 participant
@JoshuaKGoldberg