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

[docs] Clean up line breaks #1191

Open
GregAC opened this issue Nov 13, 2020 · 6 comments
Open

[docs] Clean up line breaks #1191

GregAC opened this issue Nov 13, 2020 · 6 comments
Labels
Component:Doc Documentation issue Good First Issue Good issue to work on for newcomers Type:Cleanup Cleanup tasks

Comments

@GregAC
Copy link
Contributor

GregAC commented Nov 13, 2020

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.

@mayank-kabra2001
Copy link

Sir , do we need to change in readme file ??

@GregAC
Copy link
Contributor Author

GregAC commented Dec 7, 2020

The general idea is either you have one sentence per line or wrap to 80 characters.

For README's you can argue for the 80 character wrapper to make them easy to read outside of github's markdown rendering. However for the top-level README at least the style is more one sentence per line, plus it's more of a project introduce README rather than a how you do things README so less likely someone will need read it off github.

So for the top-level README I'd say one sentence per line is the best style but other READMEs would be better left as 80 characters per line.

@rswarbrick rswarbrick added Component:Doc Documentation issue Type:Cleanup Cleanup tasks labels Jan 27, 2021
@vogelpi vogelpi added the Good First Issue Good issue to work on for newcomers label Sep 1, 2021
@m-salman-afzal
Copy link

I want to work on it for starting my open source contribution. Can anyone guide me through the process? I'll appreciate it.

@rswarbrick
Copy link
Contributor

Hi there. Thanks for the offer of help. I'd suggest you start with a single file (verification.rst, mentioned above, maybe). Reformat to ensure everything is 1 sentence per line, then push up a PR.

kal-ne added a commit to kal-ne/ibex that referenced this issue Oct 16, 2022
Reformat verification.rst to ensure everything is 1 sentence per line
@kal-ne
Copy link

kal-ne commented Oct 20, 2022

@rswarbrick I have started with a single file, verification.rst, and pushed up a PR. Can you take a look?

@kal-ne
Copy link

kal-ne commented Jan 1, 2025

Hi @GregAC @rswarbrick, could you please review my PR: #1858

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component:Doc Documentation issue Good First Issue Good issue to work on for newcomers Type:Cleanup Cleanup tasks
Projects
None yet
Development

No branches or pull requests

6 participants