82 lines
1.5 KiB
Markdown
82 lines
1.5 KiB
Markdown
|
# [Concept Name]
|
||
|
|
|
||
|
|
> **Quick Summary**: [One-sentence description of what this is and what it does.]
|
||
|
|
|
||
|
|
## Syntax
|
||
|
|
|
||
|
|
```bnf
|
||
|
|
[Formal grammar or syntax pattern]
|
||
|
|
```
|
||
|
|
|
||
|
|
### Parameters
|
||
|
|
|
||
|
|
| Parameter | Type | Required | Description |
|
||
|
|
|-----------|------|----------|-------------|
|
||
|
|
| `param1` | Type | Yes | What it does |
|
||
|
|
| `param2` | Type | No | What it does (default: value) |
|
||
|
|
|
||
|
|
## Semantics
|
||
|
|
|
||
|
|
[Precise description of behavior. What happens when this executes? What are the rules? What are the constraints?]
|
||
|
|
|
||
|
|
### Evaluation Order
|
||
|
|
|
||
|
|
[If relevant - describe how/when things are evaluated]
|
||
|
|
|
||
|
|
### Success and Failure
|
||
|
|
|
||
|
|
[If relevant - describe success/failure conditions]
|
||
|
|
|
||
|
|
## Minimal Example
|
||
|
|
|
||
|
|
```storybook
|
||
|
|
[Simplest possible working example]
|
||
|
|
```
|
||
|
|
|
||
|
|
## Complete Example
|
||
|
|
|
||
|
|
```storybook
|
||
|
|
[Realistic example showing all features]
|
||
|
|
```
|
||
|
|
|
||
|
|
## Validation Rules
|
||
|
|
|
||
|
|
- [Rule 1 with explanation]
|
||
|
|
- [Rule 2 with explanation]
|
||
|
|
- [Rule 3 with explanation]
|
||
|
|
|
||
|
|
## Common Errors
|
||
|
|
|
||
|
|
### Error: [Error Message]
|
||
|
|
|
||
|
|
**Cause**: [Why this happens]
|
||
|
|
|
||
|
|
**Solution**: [How to fix it]
|
||
|
|
|
||
|
|
```storybook
|
||
|
|
// ❌ Wrong
|
||
|
|
[bad example]
|
||
|
|
|
||
|
|
// ✅ Correct
|
||
|
|
[good example]
|
||
|
|
```
|
||
|
|
|
||
|
|
## Related Concepts
|
||
|
|
|
||
|
|
- [Related Concept 1](link) - [How they relate]
|
||
|
|
- [Related Concept 2](link) - [How they relate]
|
||
|
|
|
||
|
|
## See Also
|
||
|
|
|
||
|
|
- [Tutorial: Learning Chapter](../tutorial/chapter.md)
|
||
|
|
- [Examples: Use Case](../examples/example.md)
|
||
|
|
- [Reference: Related Feature](other-reference.md)
|
||
|
|
|
||
|
|
## Notes
|
||
|
|
|
||
|
|
[Edge cases, gotchas, performance considerations, design rationale]
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
**[Anchor ID for LSP linking]**
|