-
Notifications
You must be signed in to change notification settings - Fork 378
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
Updated README.md and RST Documentation #789
Conversation
rework of the RST docs and README cleanup of RST cleanup
This is honestly really great and should help newcomers a lot! 👍 |
@javiereguiluz can you have a look? |
Create Thumbnails | ||
----------------- | ||
|
||
.. _usage-create-thumbnails: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In Symfony Docs we usually put the label before the section title. Otherwise, when clicking a link with this anchor, you don't have a clear reference about where you are.
@robfrawley you did a huge and great work in this PR. I left some minor comments, mostly related to missing double backticks for |
…th default role
Thanks for taking the time to review the PR @javiereguiluz! Very much appreciated. I implemented all your changes, minus the backtick comments, as can be seen in this diff. As for the backticks, I started using |
0d483ed
to
7e9109e
Compare
@lsmith77 After @javiereguiluz okays my last comment, please give me a shout if you want me to squash commits before PR merge. I left the latest commits intact so @javiereguiluz could see a diff of the changes from his comments easily. |
About the |
@javiereguiluz No worries; I've just updated the PR to use double back ticks everywhere to avoid the uncertainty. |
@lsmith77 With this reviewed by @javiereguiluz, I think it is now ready to be merged! Please advise if you want the PR squashed before merge. |
Major refactoring of documentation (both in README.md and RST documentation).
Markdown README
To view how the updated README.md renders, reference robfrawley/LiipImagineBundle/blob/feature-update-docs/README.md.
ReStructuredText DOCS
To view how the updated docs render, reference src.run/docs/symfony_build/liipimaginebundle where I've compiled a build reflective of this pull-request.
The docs were built using a clone of the official Symfony Docs Repo with the required fabpot/sphinx-php python package, as well as the nessissary system binaries. Due to less-than-perfect build-conditions, as well as a lack of documentation as to how Symfony actually performs their documentation compilation, you'll notice that many of the ancillary links in the above referenced build are dead. Don't fret; our only concern is ensuring the links within the
liipimaginebundle
folder of the build function properly: the links to Symfony and other components are immaterial in this context.To better understand the doc build handling for the official documentation, reference the _build directory of the official Symfony Docs Repo.