Request for Project Documentation & Contributor Communication Channels

[rexdivakar]

Hi team 👋

I’ve been exploring this project and really like the idea behind it. I’m interested in contributing, but I noticed that the repository currently lacks detailed documentation, which makes it a bit challenging to fully understand the project’s goals, architecture, and contribution workflow.

It would be great to learn more about:

The overall vision and roadmap for the project

How the project is structured internally

Recommended ways for new contributors to get started

Additionally, do you have any communication channels such as Discord, Slack, or similar where contributors can connect, discuss ideas, and ask questions? Having a shared space for discussions would make onboarding and collaboration much easier.

I’m planning to contribute and would love to get more context before diving in. Thanks for building and maintaining this project — looking forward to learning more and collaborating! 🚀

[codeperfectplus]

Thanks a lot for your interest in the project — and for taking the time to explore it. I’m really glad the idea resonated with you.

The core vision behind this project is to build an open-source, out-of-the-box system monitoring platform that provides APIs, services, and a ready-to-use dashboard, without forcing users to design or assemble everything from scratch. The goal is to reduce the friction that usually comes with setting up monitoring, alerting, and system observability.

The repository already includes a docs/ directory with fairly extensive documentation that covers the project’s concepts, architecture, and usage. In addition, there is full documentation hosted on [Read the Docs](https://systemguard.readthedocs.io/en/latest/installation.html for easier navigation and onboarding.

I’ve been actively working on this project for over a year, and it was only recently made public and open-sourced. As a result, some areas (like contributor-focused documentation and onboarding flow) are still evolving, and improvements there are very welcome.

Feature-wise, the project is designed to help server administrators and operators with:

• System health and resource monitoring
• Configurable alerts and notifications
• A ticketing system for alert tracking and resolution
• Log viewing and analysis
• API performance testing
• Detection of running services and potentially suspicious/malicious services
• Historical system health and performance records

Regarding communication channels, we primarily use GitHub issues and pull requests for technical discussions and tracking work. In addition, we have an active Discord server where contributors can connect in real time, discuss ideas, ask questions, and collaborate more informally. As the community grows, this will continue to be the main space for faster feedback and contributor coordination.

• Discord

If you’re looking to get started, a great first step would be reviewing the documentation, running the project locally, and opening issues for any gaps or ideas you notice — documentation improvements are especially valuable right now.

Thanks again for your interest, and I’m looking forward to collaborating.