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

Split documentation between several files #5

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

Eulbobo
Copy link

@Eulbobo Eulbobo commented Oct 23, 2017

No description provided.

@cedvan
Copy link
Contributor

cedvan commented Nov 30, 2017

hi @Eulbobo,

Maybe create a doc/ folder ?

@Eulbobo
Copy link
Author

Eulbobo commented Nov 30, 2017

I'll make another version soon (up to date), in a doc folder

@Eulbobo
Copy link
Author

Eulbobo commented Nov 30, 2017

Documentation up-to-date and split into multiple files to enhance readability

@@ -3,7 +3,7 @@
`Rothenberg` allows a developper to create or maintain a Symfony application or a Symfony bundle very easily and without install something on his workstation (Mac or PC, Windows is not currently supported).
It is not a standalone project, so it must be used in the context of an another project.

## TL;DR
## Quick Start
Copy link
Contributor

Choose a reason for hiding this comment

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

👍

README.md Outdated
To run them, just do `make tests`.
Please, do not omit to update tests before implemeting new feature or doing a bug fix.
To update tests, just update the content of the `references` directory.
If you want to contribute, please refer to the [Contribution](doc/Contributing.md) section
Copy link
Contributor

Choose a reason for hiding this comment

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

Contributing.md must be in root folder ;)

Copy link
Author

Choose a reason for hiding this comment

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

Fixed !

@mageekguy mageekguy changed the title decoupage documentation Split documentation between several files Dec 4, 2017
@mageekguy
Copy link
Contributor

Hi!
Firstly, thanks for your work and your time, you rocks!
Secondly, i have no opinion about your PR currently.
We have no negative feedback about README.
In this context, splitting the documentation between several files increase the maintenance load without any advantages as counterpart.
So, i propose to put your PR in "standby" mode, and if we have some negative feedback in the future related to the README format, we will merge your PR.

@Siwayll
Copy link
Contributor

Siwayll commented Dec 19, 2017

+1 for split documentation

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.

None yet

4 participants