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

feat: make the reference to create t3 app consistent #1032

Conversation

Sboonny
Copy link
Contributor

@Sboonny Sboonny commented Dec 30, 2022

Closes #

✅ Checklist

  • I have followed every step in the contributing guide (updated 2022-10-06).
  • The PR title follows the convention we established conventional-commit
  • I performed a functional test on my final commit

Changelog

Sometimes create-t3-app was wrapped in code elements, and sometimes it didn't. For consistency, I added the code elements around it, whenever it is in a description section.


Screenshots

in /en/folder-structure#tsconfigjson path

before
image

After
image

💯

@changeset-bot
Copy link

changeset-bot bot commented Dec 30, 2022

⚠️ No Changeset found

Latest commit: d644663

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@vercel
Copy link

vercel bot commented Dec 30, 2022

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated
create-t3-app ✅ Ready (Inspect) Visit Preview Jan 3, 2023 at 10:22AM (UTC)

@github-actions github-actions bot added the 📚 documentation Improvements or additions to documentation label Dec 30, 2022
@github-actions
Copy link
Contributor

github-actions bot commented Dec 30, 2022

⚡️ Lighthouse report for the changes in this PR:

Category Score
🟠 Performance 80
🟢 Accessibility 100
🟢 Best practices 100
🟠 SEO 86
🟠 PWA 54

Lighthouse ran on https://create-t3-app-git-fork-sboonny-feat-wrap-code-ele-b82901-t3-oss.vercel.app/

@c-ehrlich
Copy link
Member

I know this is currently done inconsistently in the docs, so maybe we can use this thread to discuss what makes sense. Here's some general thoughts:

  • It should be "Create T3 App" or create-t3-app. Not "Create-T3-App" or anything else.
  • I don't think either of the two is always the right version, so it makes sense to use both based on which feels better in any given paragraph
  • There are probably some where currently the best choice isn't being used.

@Sboonny
Copy link
Contributor Author

Sboonny commented Dec 30, 2022

There are probably some where currently the best choice isn't being used.

🤔 Perhaps the links and the headings, too.

@Sboonny Sboonny marked this pull request as draft December 30, 2022 08:41
@Sboonny
Copy link
Contributor Author

Sboonny commented Dec 30, 2022

Oh btw, before I start changing stuff.

maybe we can use this thread to discuss what makes sense.

What about this, if create-t3-app refers to the CLI, we use create-t3-app. If it's refering to the stack, we use Create T3 App.

@juliusmarminge
Copy link
Member

Oh btw, before I start changing stuff.

maybe we can use this thread to discuss what makes sense.

What about this, if create-t3-app refers to the CLI, we use create-t3-app. If it's refering to the stack, we use Create T3 App.

Makes sense to me.

@c-ehrlich
Copy link
Member

Oh btw, before I start changing stuff.

maybe we can use this thread to discuss what makes sense.

What about this, if create-t3-app refers to the CLI, we use create-t3-app. If it's refering to the stack, we use Create T3 App.

I agree with this in general - the project itself is "Create T3 App", the cli/npm package is create-t3-app. I expect you'll find that there are some cases where it's difficult to separate the two, but if you want to go over the docs and give your opinions on this I think we'll end up with something that feels more consistent than what we have now :)

Copy link
Contributor Author

@Sboonny Sboonny left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I will be honest, I was lazy and decided, if it "creates" or "sets up", then it's the CLI. 😄

I am open to suggestions.

www/src/pages/en/usage/next-auth.md Outdated Show resolved Hide resolved
@Sboonny Sboonny marked this pull request as ready for review December 30, 2022 11:18
@Sboonny Sboonny changed the title feat: wrap code elements around create t3 app feat: make the reference to create t3 app consistent Dec 30, 2022
@juliusmarminge juliusmarminge merged commit 8b2f6a4 into t3-oss:next Jan 3, 2023
@Sboonny Sboonny deleted the feat/wrap-code-elements-around-create-t3-app branch January 3, 2023 10:25
joachimjusth added a commit to joachimjusth/create-t3-app that referenced this pull request Jan 5, 2023
devvianto605 pushed a commit to devvianto605/create-devviantex-nextjs-app-deprecated that referenced this pull request Jun 9, 2024
devvianto605 pushed a commit to devvianto605/create-devviantex-nextjs-app-deprecated that referenced this pull request Jun 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📚 documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants