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: improve rendering for lists #102

Closed
bmicklea opened this issue Mar 12, 2024 · 1 comment · Fixed by #107
Closed

Docs: improve rendering for lists #102

bmicklea opened this issue Mar 12, 2024 · 1 comment · Fixed by #107
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request ux Anything in the field of UX

Comments

@bmicklea
Copy link
Contributor

Describe the problem you're trying to solve
Bulleted and numbered lists in the docs are a little hard to read - they're not very indented and generally just kind of run together with the other text. See the use-cases.md as a good example.

Describe the solution you'd like
A little deeper indent on lists would help. Perhaps if there was more space between regular paragraphs and a little less at the top of the first item in a list that would help too. The docs need room to breathe! 😄

Describe alternatives you've considered
Not using lists, but that seems extreme.

Additional context
n/a

@bmicklea bmicklea added enhancement New feature or request ux Anything in the field of UX labels Mar 12, 2024
@bmicklea bmicklea changed the title Docs: improve rending for lists Docs: improve rendering for lists Mar 12, 2024
@annigro annigro linked a pull request Mar 13, 2024 that will close this issue
@bmicklea bmicklea added the documentation Improvements or additions to documentation label Mar 13, 2024
@annigro
Copy link

annigro commented Mar 13, 2024

We'll add a larger line spacing and a deeper indent. We'll also color the bullet points and numbered lists.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request ux Anything in the field of UX
Projects
None yet
2 participants