Skip to content

Commit 460ed6b

Browse files
authored
Move internals to separate directory + Improve README (#274)
1 parent 2306e10 commit 460ed6b

26 files changed

+84
-27
lines changed

README.md

Lines changed: 54 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,60 @@
1-
# The definitive guide to Yii 3.0
1+
<p align="center">
2+
<a href="https://github.com/yiisoft" target="_blank">
3+
<img src="https://yiisoft.github.io/docs/images/yii_logo.svg" height="100px" alt="Yii">
4+
</a>
5+
<h1 align="center">Yii3 Documentation</h1>
6+
<br>
7+
</p>
8+
9+
This repository contains the official documentation for Yii3 Framework, a high-performance PHP framework for building
10+
modern web applications.
11+
12+
## Documentation Sections
13+
14+
### The Definitive Guide
15+
16+
The comprehensive guide covering all aspects of the framework.
217

318
- [English](guide/en)
19+
- [Español (Spanish)](guide/es)
20+
- [Bahasa Indonesia](guide/id)
21+
- [Русский (Russian)](guide/ru)
22+
- [简体中文 (Simplified Chinese)](guide/zh-CN)
423

5-
# Yii3 community cookbook
24+
### Community Cookbook
25+
26+
A collection of community-contributed tips, tricks, and solutions for common Yii development tasks.
627

728
- [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)
37+
38+
## Contributing
39+
40+
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.
42+
43+
## License
44+
45+
The documentation is released under the terms of the BSD License.
46+
Please see [`LICENSE`](./LICENSE.md) for more information.
47+
48+
Maintained by [Yii Software](https://www.yiiframework.com/).
49+
50+
## Support the project
51+
52+
[![Open Collective](https://img.shields.io/badge/Open%20Collective-sponsor-7eadf1?logo=open%20collective&logoColor=7eadf1&labelColor=555555)](https://opencollective.com/yiisoft)
53+
54+
## Follow updates
855

9-
# Internals
10-
11-
- [000 — Packages](000-packages.md)
12-
- [001 — Yii goals and values](001-yii-values.md)
13-
- [002 — Issue workflow](002-issue-workflow.md)
14-
- [003 — Roadmap](003-roadmap.md)
15-
- [004 — Namespaces](004-namespaces.md)
16-
- [005 — Development tool](005-development-tool.md)
17-
- [006 — Git commit messages](006-git-commit-messages.md)
18-
- [007 — Exceptions](007-exceptions.md)
19-
- [008 — Interfaces](008-interfaces.md)
20-
- [009 — Design decisions](009-design-decisions.md)
21-
- [010 — Code style](010-code-style.md)
22-
- [011 — Error correction](011-error-correction.md)
23-
- [012 — Tests](012-tests.md)
24-
- [013 — Code review](013-code-review.md)
25-
- [014 — Documentation](014-docs.md)
26-
- [015 — PhpStorm metadata and attributes](015-phpstorm.md)
27-
- [016 — Security workflow](016-security-workflow.md)
28-
- [017 — Tags](017-tags.md)
29-
- [018 — Widgets](018-widgets.md)
30-
- [019 — View code style](019-view-code-style.md)
31-
- [020 — Package release](020-package-release.md)
32-
- [021 — Changelog and upgrade](021-changelog-upgrade.md)
33-
- [022 — Config groups](022-config-groups.md)
56+
[![Official website](https://img.shields.io/badge/Powered_by-Yii_Framework-green.svg?style=flat)](https://www.yiiframework.com/)
57+
[![Twitter](https://img.shields.io/badge/twitter-follow-1DA1F2?logo=twitter&logoColor=1DA1F2&labelColor=555555?style=flat)](https://twitter.com/yiiframework)
58+
[![Telegram](https://img.shields.io/badge/telegram-join-1DA1F2?style=flat&logo=telegram)](https://t.me/yii3en)
59+
[![Facebook](https://img.shields.io/badge/facebook-join-1DA1F2?style=flat&logo=facebook&logoColor=ffffff)](https://www.facebook.com/groups/yiitalk)
60+
[![Slack](https://img.shields.io/badge/slack-join-1DA1F2?style=flat&logo=slack)](https://yiiframework.com/go/slack)
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)