v1 for validating links
Todo:
- links to api docs
- links with anchors
Details
Details
- Reviewers
sashank - Commits
- R1:8133e678bec3: [docs-infra] broken link test
yarn test locally captured 486 broken links and they all make sense (yay!)
will enable the test in bk later (when we are pretty much done with the concept content)
Diff Detail
Diff Detail
- Repository
- R1 dagster
- Lint
Lint Not Applicable - Unit
Tests Not Applicable
Event Timeline
Comment Actions
Wow, nice work! This is great. I don't want you to rewrite a large portion of this, but just a few tips in case you want to clean some of the logic up here and have this logic be consistent with some of the other AST parsing we do:
You're currently using the compiler directly from MDX, but you may want to go through the remark (https://github.com/remarkjs/remark) interface to process the MDX.
- scripts/snapshot.ts has an example of running remark parser over all the MDX files that includes a custom codeTransformer step
- util/codeTransformer.ts has an example of using unist-util-visit to do the tree traversal to collect the list nodes you care about. I see that you're currently doing the AST walk by hand. You can replace "code" with "a" and "img" nodes.
These are just tips and definitely not blocking. Totally up to you about how you want to implement this. Feel free to keep as is, pending TODOs.
| docs/next/package.json | ||
|---|---|---|
| 51 | We already have fast-glob installed, can we use that instead to avoid having two glob implementations? Example usage is in scripts/snapshot.ts | |
| docs/next/__tests__/mdxInternalLinks.test.ts | ||
|---|---|---|
| 76–78 | Doesn't this mean that all links to api docs are never broken? | |
| docs/next/__tests__/mdxInternalLinks.test.ts | ||
|---|---|---|
| 76–78 | yep i marked it as a follow up TODO | |