Skip to content

docs: add CONTRIBUTING guide and expand README#5

Merged
leodiegues merged 1 commit into
mainfrom
docs/add-initial-docs
Feb 15, 2026
Merged

docs: add CONTRIBUTING guide and expand README#5
leodiegues merged 1 commit into
mainfrom
docs/add-initial-docs

Conversation

@leodiegues
Copy link
Copy Markdown
Owner

This pull request introduces significant improvements to project documentation, focusing on onboarding, usage, and contribution guidelines. The most notable changes are the addition of a comprehensive CONTRIBUTING.md file and a major rewrite of the README.md to provide clearer instructions, usage examples, and detailed reference material for users and contributors.

Documentation improvements:

  • Added a new CONTRIBUTING.md file with detailed instructions on development setup, code style, testing, and pull request workflow to help new contributors get started and follow project standards.
  • Completely rewrote the README.md to include:
    • A warning about early development status and API instability.
    • Expanded installation instructions (shell script, Cargo, building from source).
    • A quick start guide with step-by-step examples.
    • Detailed documentation for all CLI commands, their options, and usage examples.
    • Manifest file format reference, including required fields and file mapping conventions.
    • Explanation of supported remote git sources and file structure conventions.
    • Reference to the new CONTRIBUTING.md for further contribution details.

@leodiegues leodiegues self-assigned this Feb 15, 2026
@leodiegues leodiegues merged commit 3af0977 into main Feb 15, 2026
5 checks passed
@leodiegues leodiegues deleted the docs/add-initial-docs branch February 15, 2026 18:38
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.

1 participant