Skip to content

Commit 0abb66a

Browse files
committed
Improve copilot instructions
1 parent cf391d0 commit 0abb66a

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

.github/copilot-instructions.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,24 @@
1+
# Yii3 Definitive guide, cookbook, and other docs
2+
3+
The project is the source of truth for Yii3 documentation and tips. It is maintained by the Yii team and community.
4+
5+
The documentation is written in GitHub flavor Markdown format.
6+
7+
```
8+
cookbook/en/ - cookbook containing individual recipes about doing things with Yii3.
9+
guide/en/ - guide containing step-by-step instructions for learning Yii3 and covering some conceptual topics.
10+
*.md - some internal docs and top level policies.
11+
```
12+
13+
Yii3 consists of [multiple packages and respective repositories](https://github.com/topics/yii3).
14+
Each package has its own documentation that could be found in its repository and should be used to learn
15+
about the package.
16+
17+
The documentation is following a Microsoft Docs style guide which is checked with Vale Linter GitHub Action. Results
18+
are available after the action is completed.
19+
20+
Rules are:
21+
122
- Edits are permitted only in `cookbook/en`, `guide/en` and `.md` files in root directory.
223
- Conform to `014-docs.md` except translations part.
24+
- Follow individual package documentation when possible.

0 commit comments

Comments
 (0)