Skip to content

Created PHPCR-Shell documentation #12

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

Merged
merged 3 commits into from
Aug 18, 2014
Merged

Created PHPCR-Shell documentation #12

merged 3 commits into from
Aug 18, 2014

Conversation

dantleech
Copy link
Member

Started documenting PHPCR-Shell.

This PR contains:

  • Installation
  • Connecting
  • ...

----------------------------------

If you are using a Symfony2 application and the `DoctrinePHPCRBundle <https://github.com/doctrine/DoctrinePHPCRBundle/>`_
then you can easily integrate the PHPCR-Shell.
Copy link
Member

Choose a reason for hiding this comment

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

maybe we should say: "DoctrinePHPCRBundle version 1.2 or newer"

@dbu
Copy link
Member

dbu commented Aug 11, 2014

well done. do you plan to add some usage examples, or a full usage reference? maybe having just a tutorial and explain how to let the show document itself is actually more efficient than a reference that needs to stay in sync with with the tool...

@dantleech
Copy link
Member Author

I think yeah, just some usage examples, how to query, how to navigate, etc. As for a reference, we could generate that from the commands themselves - which might be a good idea as it would help expose any inaccuracies there.

@dbu
Copy link
Member

dbu commented Aug 11, 2014

either generate, or just explain to the user how to use help to get self-documentation. then he always has the documentation for his currently installed version.

@dantleech
Copy link
Member Author

Have updated with a generated reference.

Will merge this tomorrow.

@@ -0,0 +1,4151 @@
Reference
Copy link
Member

Choose a reason for hiding this comment

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

please have the generator generate a .. comment to tell this is generated and where to edit if something should be improved. avoid PR on this file :-)

Copy link
Member Author

Choose a reason for hiding this comment

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

Done

dantleech added a commit that referenced this pull request Aug 18, 2014
Created PHPCR-Shell documentation
@dantleech dantleech merged commit b0c96a6 into master Aug 18, 2014
@dantleech dantleech deleted the phpcr-shell-doc branch August 18, 2014 15:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants