Contributing to the Wiki

Contributing to the Wiki | مشارکت در ویکی

Keep pages task-oriented. A good page answers three questions:

1. What problem does this feature solve?
2. What is the smallest runnable example?
3. Where is the authoritative reference and what are the limitations?

هر صفحه بهتر است یک مفهوم را آموزش دهد، مثال قابل اجرا داشته باشد و به مستندات اصلی لینک بدهد.

Style guide | راهنمای نگارش

• Prefer short sections and concrete examples.
• State the version when behavior is release-sensitive.
• Explain why a rule exists, not just its syntax.
• Keep examples internally consistent: use the same command names and file extensions as the CLI.
• Avoid promising behavior that is not covered by tests or the reference docs.
• When updating a feature, update its example and link at the same time.

Verification checklist | چک‌لیست بررسی

plix check example.px
plix run example.px
plix build example.px -o example

For repository-level changes, also run the relevant Rust and shell test commands from CONTRIBUTING.md. Wiki changes should be small, reviewable commits with a descriptive message.