Skip to content
GitLab
Projects Groups Topics Snippets
  • /
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
  • Register
  • Sign in
  • ci ci
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributor statistics
    • Graph
    • Compare revisions
    • Locked files
  • Issues 2
    • Issues 2
    • List
    • Boards
    • Service Desk
    • Milestones
    • Iterations
    • Requirements
  • Merge requests 0
    • Merge requests 0
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Artifacts
    • Schedules
    • Test cases
  • Deployments
    • Deployments
    • Environments
    • Releases
  • Packages and registries
    • Packages and registries
    • Package Registry
    • Container Registry
    • Terraform modules
    • Model experiments
  • Monitor
    • Monitor
    • Incidents
  • Analytics
    • Analytics
    • CI/CD
    • Code review
    • Insights
    • Issue
    • Repository
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • funkwhalefunkwhale
  • cici
  • Issues
  • #4

Add documentation linter tooling

I read that the documentation tries to follow the Microsoft writing style guide. https://docs.funkwhale.audio/develop/contributor_documentation/documentation.html#style-guide

I think we can provide some help to users writing documentation by adding some tooling, such as a linter.

I have been using https://github.com/errata-ai/vale for linting documentation, the tool is really powerful, and is able to mix multiple styling guide or you can also provide your own rules (e.g. how to properly write Funkwhale).

Mixing styles is not really the goal, as they may be incompatible, but it shows the flexibility of the tool.

Assignee
Assign to
Time tracking