Refactor documentation #570
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request adds comprehensive new documentation for
sampctl, organizing guides and reference material for users managing SA:MP servers and Pawn projects. The documentation covers installation, configuration, dependency management, building, running, testing, CI, containers, and more. It introduces clear guides, quickstart, command references, and detailed explanations of configuration file fields and workflows.The most important changes are:
Core Documentation Structure:
docs/index.md) linking to all major topics, providing a clear navigation entry point for users.Getting Started and Installation:
docs/quickstart.md) and detailed install instructions (docs/install.md) to help new users set up and begin usingsampctl.Configuration and Package Management:
docs/package-definition-reference.md,docs/build-configuration-reference.md,docs/runtime-configuration-reference.md,docs/configuration.md,docs/global-config.md).Workflow Guides:
docs/packages.md,docs/dependencies.md,docs/server.md,docs/testing.md,docs/containers.md,docs/ci.md).Supporting Information:
docs/cache.md).