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

Add notes on basic usage #651

Merged
merged 1 commit into from
Oct 27, 2015
Merged

Add notes on basic usage #651

merged 1 commit into from
Oct 27, 2015

Conversation

kix
Copy link
Contributor

@kix kix commented Oct 26, 2015

Turns out the doc on Symfony website (which is generated from the RSTs in Resources/doc) lacks a description of basic bundle functionality usage. The Introduction section only describes the bundle's inner implementation, and other sections don't mention real bundle usage at all. Turns out the documentation for that was present in README.md, so I've basically converted it from Markdown to RST.

This fix should avoid confusion among the users that read the bundle's documentation on Symfony website.

using the template helper. This is likely caused by having ``intercept_redirect`` enabled in your
application configuration. To ensure that the images are rendered disable this option:

.. code-block:: jinja
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure if I did this correctly.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yeah .. not sure if one can nest like this ..

@wouterj ?

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes you can

@lsmith77 lsmith77 added the State: Reviewing This item is being reviewed to determine if it should be accepted. label Oct 26, 2015
lsmith77 added a commit that referenced this pull request Oct 27, 2015
@lsmith77 lsmith77 merged commit 9a7c8f4 into liip:master Oct 27, 2015
@lsmith77 lsmith77 removed the State: Reviewing This item is being reviewed to determine if it should be accepted. label Oct 27, 2015
.. code-block:: yaml

# app/config/config.yml

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this empty line should be removed according to Symfony doc standards

@lsmith77
Copy link
Contributor

opps .. master of docs @wouterj has some good feedback .. @kix can you do a follow up PR?

@kix
Copy link
Contributor Author

kix commented Oct 27, 2015

@wouterj, thanks a lot! I think I just got a lot better at RST now. Will do a follow-up.

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.

3 participants