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

[Maintenance] Add spell-checking and "linting" for language errors #429

Open
2 tasks done
devtobi opened this issue Oct 18, 2024 · 2 comments · May be fixed by #646
Open
2 tasks done

[Maintenance] Add spell-checking and "linting" for language errors #429

devtobi opened this issue Oct 18, 2024 · 2 comments · May be fixed by #646
Assignees
Labels
Priority: Low The issue contains work with low priority. Type: Documentation The issue contains work for the documentation Type: Maintenance The issue contains maintenance work.
Milestone

Comments

@devtobi
Copy link
Member

devtobi commented Oct 18, 2024

Relevant template

No response

Problem description (optional)

We can even more improve the linting for documentation by adding a spell checking mechanism to the contents of our markdown files.

Desired solution

I researched some possible tools (which support markdown files and are all available via node packages) and found

We need to check which rules are useful (if any).

Considered alternatives (optional)

No response

Additional context (optional)

No response

No duplicate

  • I confirm that this issue is not a duplicate

Code of Conduct

  • I agree to follow this project's Code of Conduct
@devtobi devtobi added Type: Maintenance The issue contains maintenance work. Priority: Low The issue contains work with low priority. Type: Documentation The issue contains work for the documentation labels Oct 18, 2024
@devtobi devtobi moved this from Open to Accepted in it@M RefArch Templates Nov 20, 2024
@DanielOber DanielOber added this to the Release 1.0 milestone Dec 6, 2024
@devtobi devtobi self-assigned this Dec 12, 2024
@devtobi devtobi moved this from Accepted to In Progress in it@M RefArch Templates Dec 12, 2024
@devtobi
Copy link
Member Author

devtobi commented Dec 13, 2024

I researched further into the textlint ecosystem and found the following rules useful (to be updated):
The structure below resembles the docs in textlint, however rules under "English" are not always only usable for english text.

Current state:

General

Language checking

Filter Rule List

@DanielOber
Copy link
Contributor

  • The textlint-rule-no-todo is not necessary imo. There can be parts of the documentation that are not finished, so a WIP for example would be okay to have. And with that in mind, i would also not disallow TODO.
  • textlint-rule-terminology, dont like this, if i want to write website, then let me write website. That is just too restriciting
  • textlint-rule-languagetool zero documentation on that tool, only how to use it. Dont want things like that.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Priority: Low The issue contains work with low priority. Type: Documentation The issue contains work for the documentation Type: Maintenance The issue contains maintenance work.
Projects
Status: In Progress
Development

Successfully merging a pull request may close this issue.

2 participants