Métriques du dépôt
- Stars
- (27 997 stars)
- Métriques de merge PR
- (Merge moyen 8j) (378 PRs mergées en 30 j)
Description
description
There are a number of issues with the docs that could benefit from a cleanup and some CI to prevent recurrence.
One good example is the use of single ` rather than double `` for inline-literals in rst
Currently we have a custom rst checker which only checks the version_history file and not any other part of the docs
One complexity here is that the rst is dynamically built from parts of the repo, and also the referential nature of rst itself, means that some checks can only be done after the rst has been constructed.
I think we could have some pre/post build checks - eg the current version_history check runs against the rst source in the repo.
Some checks would probably require at least a simulated build to detect in addition to the static checks that a linter might provide.
I have looked at rst linters in the past and not found any that are the perfect solution, there are a few and my takeaway was that we could probably use a bit of each, but that requires more research.
Like the problem of linting yaml (which is also a docs linting problem of sorts) there is the issue that if we add/raise standards without a clear way to fix, this can be frustrating to developers