diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 1c58a9be4cc25..c7d2861f79463 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -23,3 +23,17 @@ jobs: run: cd docs/link-checker && pnpm run check-links env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + + check-spelling: + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v4 + + - uses: ./.github/actions/setup-node + + - name: Install Global Turbo + uses: ./.github/actions/install-global-turbo + + - name: Run link checker + run: turbo run check-spelling diff --git a/docs/site/content/docs/crafting-your-repository/constructing-ci.mdx b/docs/site/content/docs/crafting-your-repository/constructing-ci.mdx index 9febc51514286..619300452d54b 100644 --- a/docs/site/content/docs/crafting-your-repository/constructing-ci.mdx +++ b/docs/site/content/docs/crafting-your-repository/constructing-ci.mdx @@ -78,7 +78,7 @@ CI/CD pipelines are a perfect place to use `--affected`. With `--affected`, Turb In the context of a PR, this means that Turborepo can determine which packages have changed between the PR's base branch and the PR's head branch. This allows you to run tasks only for the packages that are affected by the changes in the PR. -While `GITHUB_BASE_REF` works well in `pull_request` and `pull_request_target` events, it is not available during regular push events. In those cases, we use `GITHUB_EVENT_PATH` to determine the base branch to compare your commit to. In force pushes and pushing branch with no additionals commits, we compare to the parent of the first commit on the branch. +While `GITHUB_BASE_REF` works well in `pull_request` and `pull_request_target` events, it is not available during regular push events. In those cases, we use `GITHUB_EVENT_PATH` to determine the base branch to compare your commit to. In force pushes and pushing branch with no additional commits, we compare to the parent of the first commit on the branch. ### Using `turbo-ignore` diff --git a/docs/site/content/docs/support-policy.mdx b/docs/site/content/docs/support-policy.mdx index a64264bb144c7..974d945b2e2cf 100644 --- a/docs/site/content/docs/support-policy.mdx +++ b/docs/site/content/docs/support-policy.mdx @@ -76,7 +76,7 @@ Stable builds of Turborepo follow semantic versioning (semver) and are thoroughl Turborepo also offers specific APIs that may be released in an earlier phase of development. This is to allow early adopters to give valuable feedback and help the core team gain confidence in APIs ahead of their stable release. APIs that are available pre-stable will be marked as such in the documentation and within `turbo` itself whenever possible. -Not every API will be released in every phase. We use our best judgement to determine the phase for an API based on our confidence for the feature, weighing factors like the feature's complexity, possible use cases, and feedback from early users of the API. +Not every API will be released in every phase. We use our best judgment to determine the phase for an API based on our confidence for the feature, weighing factors like the feature's complexity, possible use cases, and feedback from early users of the API. The Turborepo core team would like to thank any users who do use features early and express our appreciation for any feedback you provide. diff --git a/docs/site/content/openapi/index.mdx b/docs/site/content/openapi/index.mdx index b48bd752cd60c..4a733a4e65276 100644 --- a/docs/site/content/openapi/index.mdx +++ b/docs/site/content/openapi/index.mdx @@ -1,6 +1,6 @@ --- title: OpenAPI specification -description: OpenAPI specfication for self-hosted Remote Cache servers. +description: OpenAPI specification for self-hosted Remote Cache servers. --- This page is a stub so that the sidebar shows this title at the top of the sidebar. diff --git a/docs/site/dictionary.txt b/docs/site/dictionary.txt index e18a400654826..785dd829b94fc 100644 --- a/docs/site/dictionary.txt +++ b/docs/site/dictionary.txt @@ -226,3 +226,43 @@ const repo's globbing discoverability +Nx +Nx's +Vitest's +shadcn +v8 +v9 +Configs +v9's +v1 +v2 +keybind +Keybind +composable +monorepo-friendly +TUI +misconfiguration +Turbopack +Changeset's +scaffolder +Nx-specific +Nx. +repos +GraphQL +GraphiQL +Preflight +Config +eslint-plugin-turbo. +denylist +querystring +Passthrough +eslint +eslint-plugin-turbo +amongst +namespaces +json +misconfigured +keybinds +ORM's +pre-stable +semver diff --git a/docs/site/turbo.json b/docs/site/turbo.json index 278b272e1e1c5..417b624d0f17c 100644 --- a/docs/site/turbo.json +++ b/docs/site/turbo.json @@ -41,7 +41,7 @@ "env": [] }, "check-spelling": { - "inputs": ["$TURBO_DEFAULTS$", "**/*.mdx"] + "inputs": ["$TURBO_DEFAULTS$", "**/*.mdx", "dictionary.txt"] }, "write-private-files": { "cache": false,