From 6ea56e9cc9920c386699f085b2cfeb154b4df4f3 Mon Sep 17 00:00:00 2001 From: Cameron Hall Date: Thu, 31 Jan 2019 01:07:32 +1100 Subject: [PATCH] Updated the styling and content in the README (#2202) * Updated the styling and content in the README * Update README.md * Update CONTRIBUTING.md * Update README.md --- CONTRIBUTING.md | 12 +++++++++--- README.md | 38 ++++++++++++++++++++++---------------- 2 files changed, 31 insertions(+), 19 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f5a02a91da76..42311f0cf1e8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -7,7 +7,13 @@ The repository contains all the languages that we have translations of our docum If you wish to contribute to our documentation you can do so as follows: #### Changes to English documents -Submit a PR with your modifications **only to the `en` folder. Since the English folder is the 'master' one, any changes to the files under the `en` folder will be propagated to the other languages. +Submit a PR with your modifications **only** to the `en/` folder. Since the English folder is the 'master' one, any changes to the files under the `en/` folder will be propagated to the other languages. -#### Translations -You can start translating documentation in a language other than English that you speak. You can do so by joining our project in [Crowdin](https://crowdin.com) [here](https://crowdin.com/project/phalcon-documentation/) \ No newline at end of file +#### Translations +You can start translating documentation in a language other than English that you speak. You can do so by joining our project in [Crowdin](https://crowdin.com) [here](https://crowdin.com/project/phalcon-documentation/) + +

+ + + +

diff --git a/README.md b/README.md index e607eb51b13c..9d70229d9372 100644 --- a/README.md +++ b/README.md @@ -1,25 +1,31 @@ -### Phalcon Framework - Docs -

Phalcon

-

- Hosting By: -
- - - -

+# Phalcon Framework - Documentation -Any pull requests to this repository must target the `en/` folder. All the languages are handled by + + + +You can find our documentation project in Crowdin [here](https://crowdin.com/project/phalcon-documentation) -

- - - -

+## Contributing -You can find our documentation project in Crowdin [here](https://crowdin.com/project/phalcon-documentation) +Phalcon is an open source PHP framework. This repository holds our documentation, one branch per version. +The repository contains all the languages that we have translations of our documentation for. The master language is English `en` and that is the only one that can be changed in this repository. + +If you wish to contribute to our documentation you can do so as follows: + +#### Changes to English documents +Submit a PR with your modifications **only** to the `en/` folder. Since the English folder is the 'master' one, any changes to the files under the `en/` folder will be propagated to the other languages. + +#### Translations +You can start translating documentation in a language other than English that you speak. You can do so by joining our project in [Crowdin](https://crowdin.com) [here](https://crowdin.com/project/phalcon-documentation/) + +

+ + + +