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

Tests don't exist for testable Content Guide restrictions #91

Open
danswann opened this issue Dec 20, 2023 · 0 comments
Open

Tests don't exist for testable Content Guide restrictions #91

danswann opened this issue Dec 20, 2023 · 0 comments

Comments

@danswann
Copy link
Member

Problem

Some parts of the Content Guide are testable, but no tests exist.
Examples:

  • No links in headers
  • No back-to-back links
  • Linking to a given page at most once per section
  • etc.

Context

Should add a new test action (that only runs on changes to /docs/*) which parses the .mdx files and tests for as much as possible to automate Content Guide compliance.
Probably better to set this up outside of the Docusaurus environment (e.g. with our own script that uses remark to parse the files) to avoid the tests running unnecessarily on every build.

@danswann danswann added the needs triage This is a new issue that needs to be reviewed. label Dec 20, 2023
@seanmakesgames seanmakesgames removed the needs triage This is a new issue that needs to be reviewed. label Jan 22, 2024
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

No branches or pull requests

2 participants