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

📝 Documentation: Flesh out docs for setting up bots and repo tokens #1045

Open
2 tasks done
JoshuaKGoldberg opened this issue Nov 18, 2023 · 0 comments
Open
2 tasks done
Assignees
Labels
area: documentation Improvements or additions to docs status: accepting prs Please, send a pull request to resolve this!

Comments

@JoshuaKGoldberg
Copy link
Owner

Bug Report Checklist

Overview

Right now, https://github.com/JoshuaKGoldberg/create-typescript-app/blob/e3eef39d948d132ad42a0a9e1264296a732b5e6a/docs/Creation.md says what to do when creating a new repository. But:

  • It's pretty terse and doesn't provide much detail
  • Those steps are also applicable to Initialization and Migration

I'll want to write a more informative docs page that walks users through these steps in more detail. Then that new page can be linked to in the Creation, Initialization, and Migration pages.

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 Nov 18, 2023
@JoshuaKGoldberg JoshuaKGoldberg self-assigned this Nov 18, 2023
JoshuaKGoldberg added a commit that referenced this issue Jan 4, 2024
## PR Checklist

- [x] Addresses an existing open issue: fixes #1141; fixes #1186
- [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

Adds some inline comments to end-to-end tests, as well as a more full
description of what to do with migration snapshots in development docs.
Also simplifies the migration test error to suggest looking at the docs.

Touches a little bit on what #1045 requests around more clear and
standardized token docs.

Co-authored-by: John Reilly <johnny_reilly@hotmail.com>
Co-authored-by: Mohammad Bagher Abiyat <zorofight94@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: documentation Improvements or additions to docs status: accepting prs Please, send a pull request to resolve this!
Projects
None yet
Development

No branches or pull requests

1 participant