Skip to content

update directories + file extensions for vale #3712

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

bechols
Copy link
Contributor

@bechols bechols commented Jul 28, 2025

What does this PR do?

All the lint commands in package.json are no-ops. Seems like they were targeting an outdated folder structure (the only mention of docs-src in the repo is a comment saying something was migrated from it).

They were also only targeting .md files, while most new docs files are .mdx.

This PR updates the lint command to run on all md and mdx files in /docs. The language-specific commands run on md and mdx files in /docs/develop/{language}.

I'm not sure what the desired behavior actually is. There's potentially....a lot to fix.
Cursor-index mdx (Working Tree) (index mdx) — documentation-2025-07-28 at 15 20 33@2x

@bechols bechols requested a review from a team as a code owner July 28, 2025 21:16
@axfelix
Copy link
Contributor

axfelix commented Jul 29, 2025

Yeah, I have a feeling I know what's going on here -- we used to generate .mdx from .md files that were directly edited, we moved away from that approach a while ago, and we probably never updated the Vale rules, so we haven't been following them super closely as a consequence. We were never heavily, heavily all-in on Vale, so this is a legacy process, but it's one that we should bring back. Flagging @brianmacdonald-temporal here -- if we merge this, there's going to be a lot of boring Vale fix PRs that we might not even fully agree with.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants