Add a simple Github Action to check for synax issues
Nobody has claimed this yet.
- Dominant language
- TeX
- Stars
- 43
- Forks
- 133
- Avg merge
- 11h 32m
- Merged PRs (30d)
- 4
Description
Summary:
We currently do not test whether the changes in a PR produce valid syntax. This causes minor issues at release time when we regenerate the html and PDF and need to fix all the issues merged since the last release.
Obviously this could be checked by the reviewer but I think that is unnecessary it could simply be checked with a free Github Action.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
No files, build commands, or tests are named. Start by locating the repository's documentation build workflow and the commands used to generate HTML and PDF, then determine how syntax validation can run in a GitHub Action. Done means a pull request with invalid syntax is detected automatically before release.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github-actions, tex
- Domain
- ci-cd, documentation
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100