Guides are polished instructional documents intended to remain useful as long-term technical references.
📘 What Belongs Here
- How-to guides
- Configuration guides
- Best practices
- Tool-usage references
- Concept explanations
⭐ Guide Standards
| Standard | Expectation |
|---|---|
| 🧱 Structure | Use descriptive headings and a logical reading order |
| ✅ Accuracy | Test instructions and expected outcomes |
| 📋 Context | State prerequisites and avoid hidden assumptions |
| 🏷️ Versions | Name relevant product, platform, and operating-system versions |
| 🧯 Recovery | Include troubleshooting or rollback steps where appropriate |
| 🔗 Sources | Cite authoritative references |
The Knowledge Base Article Template provides a complete starting structure.
📚 Available Guides
| Guide | Topic | Author | Status |
|---|---|---|---|
| Add your guide here | — | — | 🟡 Draft |
Add entries in this format:
| [Guide Title](/contributors/guides/page-path) | Topic | Author | 🟡 Draft |
🚀 Promotion to the Main Wiki
High-quality guides may be moved into the main wiki after editorial review. Submit finished work through Submitted Contributions.