Skip to content

Commit af4fb3d

Browse files
committed
Update README
1 parent 845e975 commit af4fb3d

File tree

1 file changed

+12
-25
lines changed

1 file changed

+12
-25
lines changed

README.md

Lines changed: 12 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -6,39 +6,26 @@
66
<br>
77
</p>
88

9-
This repository contains the official documentation for Yii3 Framework, a high-performance PHP framework for building
10-
modern web applications.
9+
This repository contains source and translations for the official documentation for Yii3 Framework,
10+
a high-performance PHP framework for building modern web applications.
1111

12-
## Documentation Sections
12+
Rendered version could be viewed at [https://yiisoft.github.io/docs/](https://yiisoft.github.io/docs/).
1313

14-
### The Definitive Guide
14+
Documentation is logically divided into three big pieces:
1515

16-
The comprehensive guide covering all aspects of the framework.
16+
- The Definitive Guide, under the `src/guide` which contains primary documentation about using Yii3 as a whole.
17+
- Community Cookbook, under `src/cookbook` which contains various recipes like "how to do X with Yii3".
18+
- Internals, under `src/internals` which are Yii3 team guidelines that are useful to check if you want to understand
19+
framework more or contribute to it.
1720

18-
- [English](guide/en)
19-
- [Español (Spanish)](guide/es)
20-
- [Bahasa Indonesia](guide/id)
21-
- [Русский (Russian)](guide/ru)
22-
- [简体中文 (Simplified Chinese)](guide/zh-CN)
23-
24-
### Community Cookbook
25-
26-
A collection of community-contributed tips, tricks, and solutions for common Yii development tasks.
27-
28-
- [English](cookbook/en)
29-
- [Русский (Russian)](cookbook/ru)
30-
31-
### Internals
32-
33-
Documentation for developers contributing to the Yii framework itself, including guidelines, workflows, and best
34-
practices.
35-
36-
- [Internals Documentation](internals)
21+
Additionally, there are translations under `src/{language code}` for multiple languages. These should not be edited
22+
directly.
3723

3824
## Contributing
3925

4026
We welcome contributions to improve the documentation, including translations.
41-
Please see the [Documentation Guidelines](internals/014-docs.md) for information on how to contribute.
27+
Please see the [Documentation Guidelines](https://yiisoft.github.io/docs/internals/014-docs.html) for information
28+
on how to contribute.
4229

4330
## License
4431

0 commit comments

Comments
 (0)