-
Notifications
You must be signed in to change notification settings - Fork 638
Open
Labels
Component:DocDocumentation issueDocumentation issueGood First IssueGood issue to work on for newcomersGood issue to work on for newcomersType:CleanupCleanup tasksCleanup tasks
Description
The source files for the documentation have a mix of styles for when lines should be broken, the verification page is a notable example: https://raw.githubusercontent.com/lowRISC/ibex/master/doc/03_reference/verification.rst which contains wrapping lines at different lengths as well as the one line for one sentence style.
Line breaking style should be checked and made consistent across all documentation files (ensuring all files comply with one line for one sentence).
We could consider a CI check to ensure documentation files are correctly formatted.
Metadata
Metadata
Assignees
Labels
Component:DocDocumentation issueDocumentation issueGood First IssueGood issue to work on for newcomersGood issue to work on for newcomersType:CleanupCleanup tasksCleanup tasks