feat: add vale for docs linting #2015
Conversation
Richard-Dang
requested review from
0xfourzerofour,
AlvaroLuken,
Dan-Nolan,
SahilAujla,
Shenghu-Yang,
Zer0dot,
adamegyed,
alex-miao,
andysim3d,
avarobinson,
blakecduncan,
dancoombs,
dphilipson,
florrdv,
jakehobbs,
joshzhang5,
linnall,
niveda-krish,
noam-alchemy and
thebrianchen
as code owners
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
How to use the Graphite Merge QueueAdd the label graphite-merge-queue to this PR to add it to the merge queue. You must have a Graphite account in order to use the merge queue. Sign up using this link. An organization admin has enabled the Graphite Merge Queue in this repository. Please do not merge from GitHub as this will restart CI on PRs being processed by the merge queue. |
🌿 Documentation Preview
|
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
Richard-Dang
force-pushed
the
richard/docs-lint
branch
from
dab8ca6 to
d9cd9d4
Compare
![graphite-app[bot]](https://avatars.githubusercontent.com/in/158384?s=60&v=4){kind=small}
| base_url = "https://www.alchemy.com" | ||
|
|
||
| # Exclude links that end with .mdx or .png | ||
| exclude = [".*\\.mdx$", ".*\\.png$"] No newline at end of file |
There was a problem hiding this comment.
Curious why exclude mdx here?
There was a problem hiding this comment.
I was getting a bunch of false positives when I didn't ignore .mdx links. Links that end in .mdx shouldn't be valid anyway
There was a problem hiding this comment.
Ah and the pngs are because they're local files. Makes sense
| - name: Install Lychee | ||
| run: | | ||
| wget -O lychee.tar.gz https://github.com/lycheeverse/lychee/releases/download/lychee-v0.20.1/lychee-x86_64-unknown-linux-gnu.tar.gz | ||
| tar -xzf lychee.tar.gz | ||
| sudo mv lychee /usr/local/bin/ |
There was a problem hiding this comment.
Did you see they already have a GitHub Action you can use?
https://github.com/lycheeverse/lychee-action/
There was a problem hiding this comment.
Yeah Vale also has GH actions available but I would need to go through IT to get them allowlisted. Didn't want to be blocked for a few days on that so this was the quickest alternative
There was a problem hiding this comment.
Ah gotcha. Ya I really hate that rule lol
3 participants
Pull Request Checklist
yarn test)sitefolder, and guidelines for updating/adding docs can be found in the contribution guide)feat!: breaking change)yarn lint:check) and fix any issues? (yarn lint:write)PR-Codex overview
This PR enhances the documentation for the
Smart Walletsproject by improving clarity, consistency, and adherence to style guidelines. It adds new linting rules, updates various sections for better readability, and introduces new configuration files.Detailed summary
.gitignoreto include.lycheecache.base_urlandexcludepatterns inlychee.toml.docs/shared/get-api-key.mdxand other MDX files.package.jsonwith new linting scripts and dependencies.