Skip to content

Conversation

@ADRFranklin
Copy link
Collaborator

@ADRFranklin ADRFranklin commented Dec 24, 2025

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:

  • Added a main documentation index (docs/index.md) linking to all major topics, providing a clear navigation entry point for users.

Getting Started and Installation:

  • Introduced a quickstart guide (docs/quickstart.md) and detailed install instructions (docs/install.md) to help new users set up and begin using sampctl.

Configuration and Package Management:

  • Added reference and guide docs for package definitions, build/runtime configuration, and global config, including field explanations and usage examples (docs/package-definition-reference.md, docs/build-configuration-reference.md, docs/runtime-configuration-reference.md, docs/configuration.md, docs/global-config.md).

Workflow Guides:

  • Provided step-by-step guides for managing dependencies, building, running, testing, using containers, and setting up CI (docs/packages.md, docs/dependencies.md, docs/server.md, docs/testing.md, docs/containers.md, docs/ci.md).

Supporting Information:

  • Added documentation for the cache directory and troubleshooting, clarifying where files are stored and how to resolve common issues (docs/cache.md).

Copilot AI review requested due to automatic review settings December 24, 2025 17:50
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR refactors the documentation for sampctl by simplifying command references and adding comprehensive new documentation files. The changes modernize the project's documentation structure, making it more accessible and easier to navigate.

Key changes:

  • Simplified command references by removing the "package" subcommand prefix (e.g., sampctl package initsampctl init)
  • Corrected installation script paths to include the /scripts/ directory
  • Added 14 new comprehensive documentation files covering installation, quickstart, packages, server configuration, testing, CI, and more

Reviewed changes

Copilot reviewed 21 out of 21 changed files in this pull request and generated 3 comments.

Show a summary per file
File Description
src/pkg/package/rook/initialise.go Updated generated file comments to use simplified command syntax; attempted to fix tab indentation but introduced escape sequence bug
src/pkg/package/pawnpackage/package.go Updated comment to reference correct config file names (pawn.json/pawn.yaml instead of samp.json/samp.yaml)
src/commands/app.go Changed error logging to verbose logging for version parsing; corrected installer script paths to include /scripts/ directory
README.md Completely restructured to be concise with links to new documentation files instead of embedding all docs
docs/*.md (14 new files) Added comprehensive documentation covering installation, quickstart, packages, server configuration, runtime configuration, build configuration, dependencies, testing, containers, CI, troubleshooting, cache, global config, and command reference

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Co-authored-by: Copilot <[email protected]>
@ADRFranklin ADRFranklin merged commit 195cd44 into master Dec 24, 2025
2 checks passed
@ADRFranklin ADRFranklin deleted the refactor-documentation branch December 24, 2025 21:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants