Skip to content

Versioned documentation for Sentinel reverse proxy

Notifications You must be signed in to change notification settings

raskell-io/sentinel.raskell.io-docs

Repository files navigation

sentinel.raskell.io-docs

Documentation site for Sentinel.

Live: https://sentinel.raskell.io/docs

Quick Start

# Install tools
mise install

# Start dev server
mise run serve

Visit http://127.0.0.1:1111

Tasks

Task Description
mise run serve Dev server with live reload
mise run build Build for production
mise run check Check for broken links
mise run clean Clean build artifacts

Structure

sentinel.raskell.io-docs/
├── config.toml           # Zola configuration
├── content/
│   ├── _index.md         # Introduction
│   ├── getting-started/  # Installation, quick start
│   ├── concepts/         # Architecture, design
│   ├── configuration/    # Config reference
│   ├── agents/           # Agent system docs
│   ├── operations/       # Production guides
│   ├── deployment/       # Deployment options
│   ├── examples/         # Example configs
│   ├── development/      # Contributing guides
│   ├── reference/        # API, CLI, metrics
│   └── appendix/         # Changelog, FAQ, license
├── syntaxes/             # Custom syntax highlighting
└── themes/tanuki/        # Documentation theme

Writing Docs

Create content/section/page.md:

+++
title = "Page Title"
weight = 1
+++

Content in Markdown...

Code blocks with syntax highlighting:

```kdl
server {
    listener "0.0.0.0:8080"
}
```

Tech Stack

  • Zola — Static site generator
  • mise — Task runner
  • Tanuki — Documentation theme

Related

License

Apache 2.0

About

Versioned documentation for Sentinel reverse proxy

Resources

Stars

Watchers

Forks

Releases

No releases published

Sponsor this project

  •  

Contributors 3

  •  
  •  
  •