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

feat: bring in CI checks for documentation #6

Open
lucaaamaral opened this issue Mar 20, 2025 · 2 comments
Open

feat: bring in CI checks for documentation #6

lucaaamaral opened this issue Mar 20, 2025 · 2 comments
Labels
bug Something isn't working enhancement New feature or request

Comments

@lucaaamaral
Copy link
Collaborator

Describe the problem

The magma/magma-documentation lacks proper CI routines to check sanity of documents introduced.

Description

This should be triggered when a PR is opened or after merge.

Additional context

Some of those checks already exist in magma/magma.

Describe your idea

Desired verifications on PRs:

  • Markdown lint.
  • Markdown files not referenced by docussaurus.
  • Markdown files updated in one language and not others.
    • The action to take on that is to open an issue after the merge to main to update the other files.

Additional context

Desired timelines

@lucaaamaral
Copy link
Collaborator Author

lucaaamaral commented Mar 21, 2025

Both magma/magma#15152 and magma/magma#15604 might have useful implementation on that regard.

@lucaaamaral lucaaamaral added the enhancement New feature or request label Mar 21, 2025
@lucaaamaral
Copy link
Collaborator Author

Desired checks:

  • Markdown lint (super-linter might implement lints for multiple languages in a single workflow)
  • Markdown FrontMatter verification - Docussaurus requires this information to serve the file
  • Docussaurus sanity check - a way to assure Docussaurus will be able to run after changes.

Useful links:

@lucaaamaral lucaaamaral added the bug Something isn't working label Apr 2, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant