Warning
This repository is intended to publish the suitefish documentation, not for issue reporting. Please submit issues at https://github.com/bugfishtm/suitefish-cms/issues.
Note: This repository is intended solely for publishing the suitefish documentation. It is not a place for bug reports, feature requests, or general support questions. If you need to report an issue or start a discussion, please use the appropriate channels linked below.
If you encounter any issues or have questions while using this software, feel free to contact us:
- GitHub Issues is the main platform for reporting bugs, asking questions, or submitting feature requests: https://github.com/bugfishtm/suitefish-cms/issues
- Discord Community is available for live discussions, support, and connecting with other users: Join us on Discord
- Email support is recommended only for urgent security-related issues: security@bugfish.eu
This table provides an overview of key files and folders related to the repository. Click on the links to access each file for more detailed information. If certain folders are missing from the repository, they are irrelevant to this project.
| Document Type | Description |
|---|---|
| .github | Folder containing GitHub configuration and workflow files. |
| .github/CODE_OF_CONDUCT.md | Community guidelines for participation. |
| .gitattributes | Git configuration file for repository attributes (dev use). |
| .gitignore | Git configuration file for ignored files/folders (dev use). |
| /docs | This folder contains the automated official documentation. |
| README.md | Main readme file for project overview and instructions. |
| repository_reset.bat | Batch script to reset the repository (dev use). |
| repository_update.bat | Batch script to update the repository (dev use). |
| CONTRIBUTING.md | Guidelines and instructions for contributors. |
| CHANGELOG.md | Main changelog file summarizing project changes. |
| SECURITY.md | Security policy and reporting instructions. |
| LICENSE.md | Project license and usage terms. |
| README.md | Main readme file (you are currently viewing this). |
The published documentation and the integrated builder build on the following open-source projects. Each remains under its own license — refer to the respective project for the full terms.
| Component | Used for | License |
|---|---|---|
| MkDocs | Static documentation site generator | BSD-2-Clause |
| Material for MkDocs | Documentation theme | MIT |
| PyMdown Extensions | Markdown extensions (admonitions, tabs, etc.) | MIT |
The builder additionally requires a PHP runtime and a MySQL / MariaDB database (for example via XAMPP), which are provided by your own environment rather than bundled here.
The license for this software can be found in the LICENSE.md file.
🐟 Bugfish