Community
GitHub Discussions
GitHub Discussions are the right place when there is no single fix or no minimal repro yet.
How to use Discussions
- Search existing threads (installation, bots, Metamod, build) before opening a new one.
- Choose a category that matches your topic (Q&A, Ideas, General — whichever your repo exposes).
- Title: one clear line (e.g. “Listen server: NodeMod admin flags”).
- Body: context (OS x64,
csr versionor git SHA, what you tried, logs if any). - When an idea becomes actionable, open a Feature request or Bug report with steps or acceptance criteria.
GitHub Issues (templates)
Use Issues for work that should end in a PR or a tracked fix:
| Template | Use for |
|---|---|
| Bug report | Crashes or wrong behaviour with steps to reproduce |
| Feature request | Concrete capability or improvement |
| Idea / discussion | Early brainstorming; may move to a feature issue later |
All templates are English and kept short on purpose.
Documentation: MkDocs vs GitHub Wiki
MkDocs (docs/ + this site) |
GitHub Wiki | |
|---|---|---|
| Versioning | Same repo and PR review as code | Separate wiki git; easy to drift |
| Search / nav | Material theme, mkdocs.yml nav, mkdocs build --strict |
Wiki search only |
| Canonical | Yes — primary documentation for CSRetro | Optional — link to Pages or docs/ instead of duplicating |
Recommendation: treat MkDocs as the single source of truth. Use the Wiki only for experiments or links if you really want it; do not copy long sections from docs/.
Contributing
See Contributing for PRs, docs updates, and coordination with Discussions/Issues.