This project includes Timolia's how-to guide.
The live site can be accessed at https://howto.timolia.de/
- 🚀 Quick Start
- 🤝 Contributing
- 🐛 Bug Reports
- 📚 Documentation Issues
- 🔗 Related Projects
- 🏆 Acknowledgments
- 📄 License
# Clone the repository
git clone https://github.com/TimoliaDE/HowTo.git
# Navigate to the project directory
cd HowTo
# Install dependencies
pnpm install
# Generate team documentation
pnpm generate-team
# Start the development server for the docs
pnpm dev:docsContributions are very welcome! Here's how you can help:
- Fork the repository
- Create a feature branch
git checkout -b feature/amazing-feature
- Make your changes
- Add tests for your changes
- Commit your changes
git commit -m 'Add: amazing feature' - Push to the branch
git push origin feature/amazing-feature
- Open a Pull Request
- Follow the existing code style
- Update documentation as needed
- Use meaningful variable names
- Add comments for complex logic
- Follow the project's ESLint configuration
Found a bug? Please use our 🐛 Bug Report template when creating an issue.
- 🐞 Description – What exactly went wrong?
- 🔁 Steps to Reproduce – How can we replicate the bug?
- ✅ Expected Behavior – What should have happened instead?
- 📸 Screenshots – If possible, add screenshots or GIFs
- 🖥️ Environment – OS, browser, Node.js version, project version
- ➕ Additional Context – Any extra info that could help
👉 Create a new bug report here: New Bug Report
If you notice missing, unclear, or outdated documentation, please use our 📚 Documentation template.
- 📖 Issue Description – What part of the docs is unclear/missing/outdated?
- 🗂️ Location – File, section, or link
- ✅ Suggested Improvements – How should it be improved?
- 📸 Screenshots – If applicable
- ➕ Additional Context – Extra notes or references
👉 Report a documentation issue here: New Documentation Issue
- PaperMC Docs - For some parts of the starlight documentation
This project is licensed under the MIT License—see the LICENSE file for details.
Made with ❤️ by Timolia