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

Check user manual with MarkdownLint #203

Merged
merged 18 commits into from
Oct 30, 2022
Merged

Check user manual with MarkdownLint #203

merged 18 commits into from
Oct 30, 2022

Conversation

Witiko
Copy link
Owner

@Witiko Witiko commented Oct 29, 2022

In our continuous integration, we run MarkdownLint on all markdown documents in the repository. However, we don't lint the biggest markdown document of all: the user manual embedded in the <manual*> sections of markdown.dtx. This pull request extracts the user manual from markdown.dtx before running MarkdownLint.

@Witiko Witiko added documentation Related the technical documentation, the user manual, and the README files technical debt Related to code smells and refactoring continuous integration Related to the continuous integration labels Oct 29, 2022
@Witiko Witiko force-pushed the feature/lint-user-manual branch from e78b467 to 79ef296 Compare October 29, 2022 23:01
@Witiko Witiko marked this pull request as ready for review October 30, 2022 15:03
@Witiko Witiko changed the title Lint user manual Check user manual with MarkdownLint Oct 30, 2022
@Witiko Witiko added this to the 2.18.0 milestone Oct 30, 2022
@Witiko Witiko merged commit d8ae860 into main Oct 30, 2022
@Witiko Witiko deleted the feature/lint-user-manual branch October 30, 2022 15:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
continuous integration Related to the continuous integration documentation Related the technical documentation, the user manual, and the README files technical debt Related to code smells and refactoring
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant