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: Fix typos #9184

Merged
merged 3 commits into from
Sep 28, 2024
Merged

docs: Fix typos #9184

merged 3 commits into from
Sep 28, 2024

Conversation

jayvdb
Copy link
Contributor

@jayvdb jayvdb commented Sep 26, 2024

Description

Fix typos using https://crates.io/crates/typos-cli

I can add the .typos.toml if that is desirable.

While the changes extend beyond docs, the only visible impact of this change will be the fixes in the docs.

Testing Instructions

@jayvdb jayvdb requested review from anthonyshew and a team as code owners September 26, 2024 00:54
@jayvdb jayvdb requested a review from tknickman September 26, 2024 00:54
@turbo-orchestrator turbo-orchestrator bot added area: docs Improvements or additions to documentation needs: triage New issues get this label. Remove it after triage owned-by: turborepo labels Sep 26, 2024
Copy link

vercel bot commented Sep 26, 2024

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

Name Status Preview Comments Updated (UTC)
examples-nonmonorepo ✅ Ready (Inspect) Visit Preview 💬 Add feedback Sep 28, 2024 8:31pm
8 Skipped Deployments
Name Status Preview Comments Updated (UTC)
examples-basic-web ⬜️ Ignored (Inspect) Visit Preview Sep 28, 2024 8:31pm
examples-designsystem-docs ⬜️ Ignored (Inspect) Visit Preview Sep 28, 2024 8:31pm
examples-gatsby-web ⬜️ Ignored (Inspect) Visit Preview Sep 28, 2024 8:31pm
examples-kitchensink-blog ⬜️ Ignored (Inspect) Visit Preview Sep 28, 2024 8:31pm
examples-native-web ⬜️ Ignored (Inspect) Visit Preview Sep 28, 2024 8:31pm
examples-svelte-web ⬜️ Ignored (Inspect) Visit Preview Sep 28, 2024 8:31pm
examples-tailwind-web ⬜️ Ignored (Inspect) Visit Preview Sep 28, 2024 8:31pm
examples-vite-web ⬜️ Ignored (Inspect) Visit Preview Sep 28, 2024 8:31pm

Copy link

vercel bot commented Sep 26, 2024

@jayvdb is attempting to deploy a commit to the Vercel Team on Vercel.

A member of the Team first needs to authorize it.

@ijjk
Copy link
Member

ijjk commented Sep 26, 2024

Allow CI Workflow Run

  • approve CI run for commit: 0b3ea0e

Note: this should only be enabled once the PR is ready to go and can only be enabled by a maintainer

@ijjk
Copy link
Member

ijjk commented Sep 26, 2024

Allow CI Workflow Run

  • approve CI run for commit: 0b3ea0e

Note: this should only be enabled once the PR is ready to go and can only be enabled by a maintainer

@jayvdb
Copy link
Contributor Author

jayvdb commented Sep 26, 2024

Many of the CI failures appear to be because I am not authorised.

The docs CI failure appears to be a bug in src/validate-docs-links.ts. When I debug it to see which headers it detects in https://github.com/vercel/turborepo/blob/main/docs/repo-docs/guides/tools/typescript.mdx , it shows

┌─────────┬───────────────────────────────────────────────────────────────────┐
│ (index) │ Values                                                            │
├─────────┼───────────────────────────────────────────────────────────────────┤
│ 0       │ 'sharing-tsconfigjson'                                            │
│ 1       │ 'use-a-base-tsconfig-file'                                        │
│ 2       │ 'creating-the-rest-of-the-package'                                │
│ 3       │ 'building-a-typescript-package'                                   │
│ 4       │ 'using-the-configuration-package'                                 │
│ 5       │ 'creating-entrypoints-to-the-package'                             │
│ 6       │ 'linting-your-codebase'                                           │
│ 7       │ 'best-practices'                                                  │
│ 8       │ 'use-tsc-to-compile-your-packages'                                │
│ 9       │ 'use-nodejs-subpath-imports-instead-of-typescript-compiler-paths' │
│ 10      │ 'just-in-time-packages'                                           │
└─────────┴───────────────────────────────────────────────────────────────────┘

i.e. the parser fails in "Just-in-Time packages" - probably the <Tabs.. construct, which also breaks the github rendering of the page. cc @anthonyshew who authored #8958 . I note that the rehype & remark deps in package.json are extremely outdated - actually almost all of the deps are at least a major version behind the latest release.

@anthonyshew
Copy link
Contributor

anthonyshew commented Sep 28, 2024

Yup, you're right on all accounts. That link validator broke somehow right before I went on parental leave, unfortunately. I'll try to fix that as soon as I can Thank you for the fixes and I'll merge once the rest of CI passes!

@anthonyshew anthonyshew merged commit ad4cf20 into vercel:main Sep 28, 2024
42 of 43 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: docs Improvements or additions to documentation needs: triage New issues get this label. Remove it after triage
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants