Skip to content

Improve README #14675

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.

Sign up for GitHub

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 1 commit into from
Dec 8, 2020
Merged

Improve README #14675

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 20 additions & 7 deletions README.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,20 @@
Symfony Documentation
=====================

This documentation is rendered online at https://symfony.com/doc/current/
<p align="center"><a href="https://symfony.com" target="_blank">
<img src="https://symfony.com/logos/symfony_black_02.svg">
</a></p>

<h3 align="center">
The official Symfony Documentation
</h3>

<p align="center">
<a href="https://symfony.com/doc/current/index.html">
Online version
</a>
<span> | </span>
<a href="https://symfonycasts.com">
Screencasts
</a>
</p>

Contributing
------------
Expand All @@ -11,8 +24,8 @@ Symfony documentation, please read
[Contributing to the Documentation](https://symfony.com/doc/current/contributing/documentation/overview.html)

> **Note**
> All pull requests must be based off of the **4.4** branch,
> unless you're documenting a feature that was introduced *after* Symfony 4.4
> All pull requests must be based on the ``4.4`` branch,
> unless you are documenting a feature that was introduced *after* Symfony 4.4
> (e.g. in Symfony 5.2), **not** the ``5.x`` or older branches.

SymfonyCloud
Expand All @@ -24,7 +37,7 @@ server where Pull Requests are built and can be reviewed by contributors.
Docker
------

You can build the doc locally with these commands:
You can build the documentation project locally with these commands:

```bash
# build the image...
Expand Down