Skip to content

cactusmod/documentation

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

6 Commits
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

🌡 Documentation

This repo contains markdown-based pages for our documentation page, which is built using MkDocs.

✍️ Contributing

We welcome contributions to improve and expand this documentation!

You can help by:

  • πŸ“˜ Adding documentation for undocumented features
  • ✏️ Expanding or improving existing pages
  • ❓ Contributing to the FAQ or changelog

πŸ“Œ How to Contribute

1. Fork the repository

Click the "Fork" button at the top-right of this page to create your own copy of the repository.

2. Make your changes

Edit and / or create the relevant .md files.

Keep structure consistent - if you're unsure, check how other pages are formatted.

3. Create a Pull Request

  • Go to your fork on GitHub
  • Click "Compare & pull request"
  • Add a descriptive title and a short summary of your changes
  • Submit the pull request

We will review it and give feedback if needed.

πŸ“ Contribution Guidelines

  • βœ… Keep content clear and concise.
  • βœ… Use consistent formatting - headings, code blocks, tables, etc.
  • βœ… Stick to the existing structure - unless you're improving it in a big way.
  • βœ… Use proper grammar and punctuation.
  • ⚠️ Please make experimental or unreleased features as such to avoid confusion.
  • 🚫 Please don't let AI write pages for you. If you want to contribute, actually do it yourself.

If you're unsure, feel free to open an issue or ask in our Discord.

Thanks for helping us expand the Cactus Mod docs and make them better for everyone! We appreciate every contribution.

About

Documentation for CactusMod

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published