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

fix docs link checker #9311

Merged
merged 31 commits into from
Oct 23, 2024
Merged
Show file tree
Hide file tree
Changes from 25 commits
Commits
Show all changes
31 commits
Select commit Hold shift + click to select a range
396a9b6
wip
dimitropoulos Oct 22, 2024
fc108ad
update all the things*
dimitropoulos Oct 22, 2024
6691176
error handling supported locally
dimitropoulos Oct 22, 2024
bad577d
format reportRows for GitHub
dimitropoulos Oct 22, 2024
b131796
improve comment reporting
dimitropoulos Oct 22, 2024
2a45689
this is the thing that's been breaking our docs links checker.. :not-…
dimitropoulos Oct 22, 2024
0663d7c
ready to test GitHub
dimitropoulos Oct 22, 2024
38efd11
remove local env (it now works locally without it)
dimitropoulos Oct 22, 2024
ab2b0e1
update node on docs link check runner
dimitropoulos Oct 22, 2024
8793489
fix path for action
dimitropoulos Oct 22, 2024
126f044
include pnpm
dimitropoulos Oct 22, 2024
84dfac9
use the thing we have for this
dimitropoulos Oct 22, 2024
f42931e
make it fail and see what happens
dimitropoulos Oct 22, 2024
f3c80ac
what would it be like if we just failed normally
dimitropoulos Oct 22, 2024
b9d41fd
Revert "make it fail and see what happens"
dimitropoulos Oct 22, 2024
9816349
removes more
dimitropoulos Oct 22, 2024
d3b769e
really not sure why these lint errors are suddenly appearing on this …
dimitropoulos Oct 22, 2024
de6b47f
Revert "really not sure why these lint errors are suddenly appearing …
dimitropoulos Oct 22, 2024
1e67c5d
bounch back to typescript 5.3.3
dimitropoulos Oct 23, 2024
9470a65
normalizePath -> filePathToUrl
dimitropoulos Oct 23, 2024
03e547a
move EXCLUDED_PATHS to top level
dimitropoulos Oct 23, 2024
fb9543e
Update docs/src/markdown.ts
dimitropoulos Oct 23, 2024
ef2d43b
vastly simplify getAllMdxFilePaths
dimitropoulos Oct 23, 2024
6426209
last intentional check before merging (will revert)
dimitropoulos Oct 23, 2024
4c4f000
Revert "last intentional check before merging (will revert)"
dimitropoulos Oct 23, 2024
048e3f5
fix formatting
dimitropoulos Oct 23, 2024
91ef9fc
revert unnecessary mdx formatting change
dimitropoulos Oct 23, 2024
7bb726f
Merge branch 'main' into dimitri/docs-tests
dimitropoulos Oct 23, 2024
8459125
fix formatting
dimitropoulos Oct 23, 2024
da62c4b
Revert "fix formatting"
dimitropoulos Oct 23, 2024
5ded22c
fix formatting
dimitropoulos Oct 23, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,14 @@ jobs:
validate-docs-links:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Checkout
uses: actions/checkout@v4

- name: "Setup Node"
uses: ./.github/actions/setup-node
- uses: ./.github/actions/setup-node
with:
node-version: 20

- name: "Run link checker"
- name: Run link checker
run: cd docs && pnpm run check-links
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
24 changes: 10 additions & 14 deletions docs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,21 +9,17 @@
"check-links": "tsx src/validate-docs-links.ts"
},
"devDependencies": {
"@types/github-slugger": "^1.3.0",
"@types/node": "^22.1.0",
"@vercel/ncc": "0.34.0",
"tsx": "^4.7.2",
"typescript": "5.1.6"
"@types/node": "22.7.8",
"tsx": "4.19.1",
"typescript": "5.3.3"
},
"dependencies": {
"@actions/core": "^1.10.0",
"@actions/github": "^5.1.1",
"github-slugger": "1.2.0",
"gray-matter": "4.0.2",
"rehype-raw": "4.0.1",
"remark-parse": "7.0.1",
"remark-rehype": "5.0.0",
"unified": "8.4.1",
"unist-util-visit": "2.0.0"
"github-slugger": "2.0.0",
"gray-matter": "4.0.3",
"rehype-raw": "7.0.0",
"remark-parse": "11.0.0",
"remark-rehype": "11.1.1",
"unified": "11.0.5",
"unist-util-visit": "5.0.0"
}
}
14 changes: 8 additions & 6 deletions docs/repo-docs/guides/tools/typescript.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,9 @@ Inside `packages/typescript-config`, you have a few `json` files which represent
}
```

<LinkToDocumentation href="https://www.typescriptlang.org/tsconfig">`tsconfig` options reference</LinkToDocumentation>
<LinkToDocumentation href="https://www.typescriptlang.org/tsconfig">
dimitropoulos marked this conversation as resolved.
Show resolved Hide resolved
`tsconfig` options reference
</LinkToDocumentation>

### Creating the rest of the package

Expand Down Expand Up @@ -292,15 +294,15 @@ In [Compiled packages](https://turbo.build/repo/docs/core-concepts/internal-pack
</Tab>

<Tab value="Source code">

```tsx title="./packages/ui/button.tsx"
import { MY_STRING } from "#utils.js" // Uses .js extension // [!code highlight]
import { MY_STRING } from '#utils.js'; // Uses .js extension // [!code highlight]
dimitropoulos marked this conversation as resolved.
Show resolved Hide resolved

export const Button = () => {
return (
<button>{MY_STRING}</button>
)
}
return <button>{MY_STRING}</button>;
};
```

</Tab>

</Tabs>
Expand Down
126 changes: 0 additions & 126 deletions docs/src/github.ts

This file was deleted.

Loading
Loading