Sun Project Documentation

Welcome to Planet

Welcome to the Great Sun Project! This documentation will guide you through our comprehensive platform ecosystem.

We have a comprehensive platform called Planet, which is a complete system for launching websites with extensive features. This platform consists of two main components:

Core Components

• Sun: The core API server that powers all clients. In other words, Sun is the beating heart of the platform.
• Jupiter: Refers to our clients and customers, who rely on Sun's services.

warning

Your are entering the Docs Zone 🚀 May Cause Brain Overload 🧠💥

Getting Started

New Developers

If you're new to the Planet project, we recommend starting with:

1. Read the Requirements document
2. Set up your Docker environment
3. Complete the Project Setup
4. Review our Development Guidelines

Existing Team Members

If you're already familiar with the Planet project:

1. Check for any recent updates to the platform
2. Review the API documentation for any changes
3. Explore the advanced features you might not be using

Contributors

If you're looking to contribute to the Planet project:

1. Familiarize yourself with our coding standards
2. Review the GitHub workflow
3. Check our open issues

Project Overview

This documentation site provides comprehensive information about the Sun API and related services. The content is organized to help developers quickly find the information they need to work effectively on the Planet project.

Quick Navigation

Use the sidebar navigation to browse through different sections, or use the search functionality at the top to quickly find specific information.

How to Use This Documentation

The documentation is structured to guide you through different aspects of the Sun API:

Section	Description	For Whom
API Basics	Core concepts, URL structure, and common patterns	All developers
Admin API	Documentation for administrative endpoints and features	Backend developers, Admins
Client API	Documentation for client-facing endpoints and features	Frontend developers, API users
Development	Guidelines for contributing to the codebase	Contributors
Tutorials	Step-by-step guides for common tasks	New developers

Contributing to Documentation

We welcome contributions to improve this documentation. To contribute:

1. Fork the GitHub repository
2. Make your changes following our documentation standards
3. Submit a pull request with a clear description of your improvements

Documentation Standards

When contributing to the documentation, please follow these guidelines:

• Use clear, concise language
• Include code examples where appropriate
• Add screenshots for UI-related features
• Test all code examples before submitting

Support and Community

If you need help or have questions about the Planet project:

• Join our Discord community
• Check the FAQ section
• Submit an issue on GitHub

Thank you for being part of the Planet project community!