Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Conversation

a234asthana
Copy link

improvements made for step readability

This is a 馃敠 documentation change.

  • I've adjusted the documentation (if it's a feature or enhancement)

Summary

Created a bulleted list for showing steps.

Context

improvements made for steps readability
@a234asthana
Copy link
Author

I would like to improve other document pages if this is approved.

@ashmaroli
Copy link
Member

Hello @a234asthana, thank you for proposing improvements to the docs.

However based on the current state of the head-branch, the changes appear to be inconsistent and therefore incomplete:

deploy-preview-9751--1

Issues

  • The bullet-points appear to be children of the first paragraph (concerned with installing Ruby) of the section. But the contents of those bullet-points are in reality, not related to the first paragraph at all.
  • The bulleted contents should appear to be contiguous. i.e. The text and following code-block should be indented by the same amount in order to maintain visual flow. (Please see the Quickstart instructions to get an idea of what I mean.)
  • A cursory Google search shows that Step by step is valid usage and therefore hyphenating to Step-by-step is unnecessary.

@ashmaroli
Copy link
Member

P.S. You need not rebase your branch after you commit your changes.

@a234asthana
Copy link
Author

Hi @ashmaroli, I got your point. Thanks for the reference link.
So, in this case, we can skip the changes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

Morty Proxy This is a proxified and sanitized view of the page, visit original site.