This repository has been archived by the owner on Dec 30, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 485
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
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
- Loading branch information
1 parent
485c457
commit 6ea56e9
Showing
2 changed files
with
31 additions
and
19 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,25 +1,31 @@ | ||
### Phalcon Framework - Docs | ||
|
||
<p align="center"><a href="https://docs.phalconphp.com" target="_blank"> | ||
<img src="https://assets.phalconphp.com/phalcon/logo-transparent-phalcon-black.svg" height="100" alt="Phalcon"/> | ||
</a></p> | ||
|
||
<p align="center"> | ||
Hosting By: | ||
<br /> | ||
<a href="https://www.netlify.com"> | ||
<img src="https://www.netlify.com/img/global/badges/netlify-color-accent.svg"/> | ||
</a> | ||
</p> | ||
# Phalcon Framework - Documentation | ||
|
||
Any pull requests to this repository must target the `en/` folder. All the languages are handled by | ||
<a href="https://www.netlify.com"> | ||
<img src="https://www.netlify.com/img/global/badges/netlify-color-accent.svg"/> | ||
</a> | ||
|
||
You can find our documentation project in Crowdin [here](https://crowdin.com/project/phalcon-documentation) | ||
|
||
<p align="center"> | ||
<a href="https://www.netlify.com"> | ||
<img src="https://support.crowdin.com/assets/logos/crowdin-CollaborativeTranslationTool-logo.png"/> | ||
</a> | ||
</p> | ||
## 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/) | ||
|
||
<p> | ||
<a href="https://crowdin.com"> | ||
<img src="https://support.crowdin.com/assets/logos/crowdin-CollaborativeTranslationTool-logo.png" width="40%"/> | ||
</a> | ||
</p> |