Squashed commit message
Some checks are pending
Telegram Mini App Shop Builder / Compute version metadata (push) Waiting to run
Telegram Mini App Shop Builder / Run Frontend tests (push) Waiting to run
Telegram Mini App Shop Builder / Run Backend tests (push) Waiting to run
Telegram Mini App Shop Builder / Run PHP_CodeSniffer (push) Waiting to run
Telegram Mini App Shop Builder / Build module. (push) Blocked by required conditions
Telegram Mini App Shop Builder / release (push) Blocked by required conditions

This commit is contained in:
2026-03-11 22:08:41 +03:00
commit 3cc82e45f0
585 changed files with 65605 additions and 0 deletions

View File

@@ -0,0 +1,61 @@
# Prompts for documentation
## Documenting a class
```
Add PHPDoc documentation for class [CLASS_NAME]:
1. Description of the class and its purpose
2. @package tag
3. @author tag
4. Documentation for all public methods
5. Documentation for public properties
6. Usage examples where appropriate
```
## Documenting a method
```
Add PHPDoc for method [METHOD_NAME]:
1. Method description
2. @param for all parameters with types
3. @return with the return type
4. @throws for all exceptions
5. Usage examples if the logic is complex
```
## Documenting an API endpoint
```
Create documentation for API endpoint [ENDPOINT_NAME]:
1. Description of purpose
2. HTTP method and path
3. Request parameters (query/body)
4. Response format (JSON structure)
5. Error codes
6. Request/response examples
7. Authorization requirements
```
## Documenting a Vue component
```
Add documentation for Vue component [COMPONENT_NAME]:
1. Component description
2. Props with types and descriptions
3. Emits with descriptions
4. Slots if present
5. Usage examples
6. Dependencies on other components
```
## Creating a README
```
Create README.md for [MODULE/COMPONENT]:
1. Purpose description
2. Installation/configuration
3. Usage with examples
4. API documentation
5. Configuration options
6. Troubleshooting
```