Skip to content

About

Official Documentation

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

📚 AdminService.Cloud Docs

CI Deploy

📌 About

The public documentation site for the AdminService.Cloud project: the asc-daemon CLI and the platform built on top of it. Built with VitePress, deployed to GitHub Pages. English and Russian content side by side (docs/ and docs/ru/).

🗂️ Structure

Path Description
docs/cli/ CLI (asc-daemon) module docs — English
docs/commands/ Command reference — one page per top-level asc command, linked from asc <cmd> --help
docs/platform/ Platform docs (in development)
docs/ru/ Russian mirror of cli/, commands/ and platform/
docs/.vitepress/ VitePress config, theme and components

⚠️ This site is a mirror, not a build artifact: CLI module docs and command reference pages are the source of truth in asc-daemon's docs/english/ and docs/russian/, copied here by hand on every change (see asc-daemon's AGENTS.md). Adding, removing or renaming a command requires a matching page/heading update here in the same change, or the printed --help links 404.

⌨️ Local development

Requires pnpm and, optionally, Task (go install github.com/go-task/task/v3/cmd/task@latest) to run the shortcuts below.

task install
task dev

📥 install dependencies, 🚀 run the VitePress dev server

task build

📦 build the static site — also fails the build on dead links

task preview

👀 build, then preview the production output locally

Without Task, the same commands are pnpm install, pnpm docs:dev, pnpm docs:build, pnpm docs:preview. Run task (no arguments) to list all available commands.

🚀 Deployment

Every push to main builds the site and deploys it to GitHub Pages via .github/workflows/deploy.yml; every pull request runs .github/workflows/ci.yml to make sure the build (including link checking) still passes.

Self-hosted copy (docs.adminservice.cloud): docker compose up -d --build builds the same site into an nginx image (Dockerfile, compose.yaml) and publishes it on 127.0.0.1:8080; set HTTP_PORT / HTTP_BIND in .env and put a TLS reverse proxy in front.

🤝 Contributing

Follow the documentation conventions from asc-daemon's AGENTS.md: English-first, Russian mirrored, emoji in headings, commits in English following Conventional Commits.

📄 License

Documentation content and site source are part of the AdminService.Cloud project by Omar El Sayed (@statebyte), Anytecture Software.

About

Official Documentation

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Contributors

Languages