Skip to content

docs: document recent feature surface#104

Merged
ZingerLittleBee merged 11 commits intomainfrom
amman-v1
May 1, 2026
Merged

docs: document recent feature surface#104
ZingerLittleBee merged 11 commits intomainfrom
amman-v1

Conversation

@ZingerLittleBee
Copy link
Copy Markdown
Owner

@ZingerLittleBee ZingerLittleBee commented May 1, 2026

Summary

  • Add docs for dashboards, file manager, service monitors, and expanded status pages
  • Update admin, alerts, monitoring, capabilities, themes, API reference, and navigation docs
  • Cover GeoIP/Traceroute, scheduled tasks, maintenance suppression, APNs, branding, and current WebSocket/API routes

Test Plan

  • make docs-typecheck

Summary by CodeRabbit

Release Notes

  • Documentation
    • Comprehensive documentation added for scheduled tasks with cron scheduling, synthetic service monitors (SSL, DNS, HTTP keyword, TCP, WHOIS), custom multi-layout dashboards with various widget types, remote file manager with security controls, network traceroute diagnostics, and configurable multi-page status pages.
    • Added guides for white-label branding, APNs push notifications, and enhanced API/WebSocket endpoint documentation.

@vercel
Copy link
Copy Markdown

vercel Bot commented May 1, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
server-bee-docs Ready Ready Preview, Comment May 1, 2026 5:45pm

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 1, 2026

Caution

Review failed

Pull request was closed or merged during review

📝 Walkthrough

Walkthrough

This pull request expands ServerBee's documentation across both Chinese and English locales, introducing and detailing new features including scheduled task management, event-driven alerting, custom dashboards, file manager with security controls, service monitoring, status pages with incidents/maintenance support, and comprehensive API documentation including WebSocket routes.

Changes

Cohort / File(s) Summary
Task Management
apps/docs/content/docs/cn/admin.mdx, apps/docs/content/docs/en/admin.mdx
Documents distinction between one-off and scheduled tasks, including cron expression syntax, retry configuration with constraints, run_id grouping, overlap-skip behavior, manual execution, disable/delete semantics, and synthetic exit codes for failure modes.
Alerting System
apps/docs/content/docs/cn/alerts.mdx, apps/docs/content/docs/en/alerts.mdx
Expands alert types to include event-driven ip_changed alerts alongside threshold rules; adds expiration and cycle_interval/cycle_limit configuration; documents maintenance-window suppression while rules still evaluate; adds APNs notification channel documentation.
API Reference & WebSocket
apps/docs/content/docs/cn/api-reference.mdx, apps/docs/content/docs/en/api-reference.mdx, apps/docs/content/docs/cn/mobile.mdx, apps/docs/content/docs/en/mobile.mdx
Reorganizes endpoint documentation from capability-based to family-based categories; standardizes REST response wrappers (data/error); adds Bearer token authentication; expands WebSocket endpoints with agent token, server updates, terminal proxy, and Docker log streaming; updates iOS WebSocket endpoint from /api/ws/browser to /api/ws/servers.
Capabilities & Security
apps/docs/content/docs/cn/capabilities.mdx, apps/docs/content/docs/en/capabilities.mdx
Extends capability enforcement to cover scheduled task execution, server upgrades (CAP_UPGRADE), ping/traceroute probing (CAP_PING_ICMP), file manager operations (CAP_FILE), and Docker operations (CAP_DOCKER); adds File Manager UI navigation entry.
Configuration
apps/docs/content/docs/cn/configuration.mdx, apps/docs/content/docs/en/configuration.mdx
Generalizes GeoIP MMDB documentation from GeoLite2-specific to MaxMind-compatible; documents empty-value behavior allowing DB-IP Lite download via Settings UI.
Branding & Themes
apps/docs/content/docs/cn/custom-themes.mdx, apps/docs/content/docs/en/custom-themes.mdx
Introduces brand settings documentation (site_title, footer_text, logo_path, favicon_path) with public read endpoints and admin endpoints for updating JSON metadata and uploading logo/favicon via multipart; specifies PNG/ICO file types and 512 KB limit.
Dashboards & Widgets
apps/docs/content/docs/cn/dashboards.mdx, apps/docs/content/docs/en/dashboards.mdx
New documentation pages explaining dashboard management (create, rename, delete, set default), widget types and configuration fields, grid-coordinate-based layout editing with diff-based updates, GeoIP dependency for Server Map, and dashboard API endpoints with example payloads.
File Manager
apps/docs/content/docs/cn/file-manager.mdx, apps/docs/content/docs/en/file-manager.mdx
New documentation pages detailing controlled remote filesystem access, two-layer enablement (CAP_FILE/agent policy), role-based permissions, audit logging, security model (allow-listed roots, path containment, deny-patterns), operational limits, chunked transfers, and File Manager API with example curl commands.
Monitoring & Observability
apps/docs/content/docs/cn/monitoring.mdx, apps/docs/content/docs/en/monitoring.mdx
Adds GeoIP setup section with MMDB path and DB-IP Lite download flow; documents Traceroute feature including agent capability requirement, hop/timeout parameters, OS-specific execution, and asynchronous request_id-based polling; updates WebSocket endpoint reference to /api/ws/servers.
Service Monitors
apps/docs/content/docs/cn/service-monitors.mdx, apps/docs/content/docs/en/service-monitors.mdx
New documentation pages for synthetic service monitoring covering monitor types (SSL, DNS, HTTP keyword, TCP, WHOIS), configuration schemas, pass/fail semantics, notification/retry state transitions, maintenance-window suppression, and Service Monitors API with example create requests.
Status Pages
apps/docs/content/docs/cn/status-page.mdx, apps/docs/content/docs/en/status-page.mdx
Restructures from single public status page to multi-page system; documents configurable pages at /status/{slug}, per-page settings (server selection, uptime thresholds, theme, custom CSS), incidents/maintenance management, and expanded public/admin API surface with incident lifecycle and CRUD endpoints.
Navigation & Index
apps/docs/content/docs/cn/index.mdx, apps/docs/content/docs/en/index.mdx, apps/docs/content/docs/cn/meta.json, apps/docs/content/docs/en/meta.json
Updates feature descriptions in index pages to reflect new capabilities (scheduled tasks, Docker, file manager, service monitors, status pages); adds navigation cards for dashboards, file manager, service monitors, custom themes; updates meta.json pages array with three new route entries (dashboards, service-monitors, file-manager).

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Poem

📚✨ A rabbit hops through docs so bright,
New dashboards, files, alerts—what a sight!
From scheduled tasks to status pages grand,
Service monitors and Docker, features oh so planned!
With features mapped in both tongues true,
The docs now sing of all we can do! 🐰

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'docs: document recent feature surface' accurately reflects the primary change: comprehensive documentation additions and updates for newly launched features (dashboards, file manager, service monitors, status pages, scheduled tasks, and related capabilities).
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch amman-v1

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
Review rate limit: 0/1 reviews remaining, refill in 60 minutes.

Comment @coderabbitai help to get the list of available commands and usage tips.

@ZingerLittleBee ZingerLittleBee merged commit cb27ad4 into main May 1, 2026
9 of 10 checks passed
@ZingerLittleBee ZingerLittleBee deleted the amman-v1 branch May 1, 2026 17:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant