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

Lint Documentation MD files on CI #268

Closed
3 tasks done
marcelstanley opened this issue Jan 19, 2024 · 0 comments · Fixed by #275
Closed
3 tasks done

Lint Documentation MD files on CI #268

marcelstanley opened this issue Jan 19, 2024 · 0 comments · Fixed by #275
Assignees

Comments

@marcelstanley
Copy link
Contributor

marcelstanley commented Jan 19, 2024

📚 Context

The node docs is comprised of several MDfiles, either manually created or automatically generated.

Sometimes a developer might make changes that are not formatted right and such mistakes go unnoticed.

This is a follow-up to #266

✔️ Solution

Consider enabling markdown at .golangci.yml.

If not possible, add a linter action to CI.

Linters below may be considered:

📈 Subtasks

  • Add MD linter action to CI
  • Add corresponding recipe to Makefile
  • Disable linter rules on non-documentation files
@marcelstanley marcelstanley self-assigned this Jan 19, 2024
@marcelstanley marcelstanley changed the title Lint Markdown files on CI Lint Documentation MD files on CI Jan 19, 2024
@marcelstanley marcelstanley moved this to 📋 Backlog in Node Unit Jan 22, 2024
@marcelstanley marcelstanley moved this from 📋 Backlog to 🏗 In progress in Node Unit Jan 22, 2024
@github-project-automation github-project-automation bot moved this from 🏗 In progress to ✅ Done in Node Unit Jan 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

1 participant