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

Collection of rules for linting #64

Open
5 tasks
ralf401 opened this issue Mar 6, 2025 · 0 comments
Open
5 tasks

Collection of rules for linting #64

ralf401 opened this issue Mar 6, 2025 · 0 comments
Labels
📚documentation📚 Improvements or additions to documentation 🛠️ Maintenance 🛠️ On hold Waiting for availability in Desktop View

Comments

@ralf401
Copy link
Collaborator

ralf401 commented Mar 6, 2025

This is a collection of thinks which come to my mind while writing the documentation. At some point we can talk about them and decide which one to include.

  • External links with added {target=_blank}
  • Check if dead internal links are present
  • Special keyboard keys like enter or ctrl which have the [[ ]] markup => enforce small or capital letter at the beginning?
  • Code blocks without $ at the beginning
  • Headings only by using #
@ralf401 ralf401 added On hold Waiting for availability in Desktop View 📚documentation📚 Improvements or additions to documentation 🛠️ Maintenance 🛠️ labels Mar 6, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📚documentation📚 Improvements or additions to documentation 🛠️ Maintenance 🛠️ On hold Waiting for availability in Desktop View
Projects
None yet
Development

No branches or pull requests

1 participant