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

[WIP] Documentation for focused specs. #3

Merged
merged 2 commits into from
Jan 19, 2017
Merged

[WIP] Documentation for focused specs. #3

merged 2 commits into from
Jan 19, 2017

Conversation

ezzatron
Copy link
Contributor

@ezzatron ezzatron commented Dec 7, 2016

Related documentation for peridot-php/peridot#185 and peridot-php/peridot#197.

@ezzatron
Copy link
Contributor Author

ezzatron commented Dec 8, 2016

@brianium I couldn't resist fixing up some other minor issues while I was making this change. It's a bit crufty from that perspective, but it's all stuff I would have liked to fix up before a release anyway.

A list of additional stuff in this PR, in no particular order:

  • Fixed a CSS issue with dot point lists, where the list item content would appear below the list item dot.
  • Utilized {% highlight php startinline %} where possible, and removed <?php and ?> where appropriate for succinctness.
  • Updated the composer require install instructions, as the version number is not required / actually detrimental in the most common case, where users just want the latest version.
  • Updated the entire CLI options documentation section, and attempted to order it in terms of most commonly used options.

@brianium
Copy link
Member

brianium commented Dec 8, 2016

Dannnnnng. Good work man. I didn't know about {% highlight php startinline %}

I'm comfortable with all of these changes. Pretty excited about this next release man :)

@brianium
Copy link
Member

brianium commented Dec 8, 2016

I se the [WIP] title on here, so I won't merge quite yet. Let me know when you have things where you want them. Thanks!

@ezzatron
Copy link
Contributor Author

ezzatron commented Dec 8, 2016

@brianium Awesome man, I'm pretty stoked too :)

I'll squash the commits now. If we merge these into master, does it immediately become public? If that's the case, we should probably wait until we make the actual release, yeah?

@brianium
Copy link
Member

@ezzatron I believe it does become public, so I will hold off on the merge for now.

@ezzatron ezzatron merged commit 097e5f1 into master Jan 19, 2017
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