Skip to content

docs: align README, AGENTS.md and llms.txt with current SuperPlane positioning #202

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
arunimshukla wants to merge 4 commits into
base: main
Choose a base branch
from
Open

docs: align README, AGENTS.md and llms.txt with current SuperPlane positioning #202

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
7c01316
docs: align README with AI software factory positioning
arunimshukla Sep 7, 2026
f5a220b
docs: clarify agent and workflow guardrails
arunimshukla Sep 7, 2026
eeeebac
Update README.md
arunimshukla Sep 7, 2026
e2c8941
Update generate-llms.mjs
arunimshukla Sep 7, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,12 @@ This document provides guidelines for AI agents working with the SuperPlane docu
## Repository Overview

This repository contains the documentation for
[SuperPlane](https://github.com/superplanehq/superplane), an open source DevOps
control plane. The documentation site is built with
[SuperPlane](https://github.com/superplanehq/superplane), an open source AI
software factory for engineering teams. SuperPlane coordinates agents and
deterministic workflows to turn high-confidence routine work into verified,
review-ready pull requests. Workflows define scope, checks, approvals,
feedback, and escalation; agents perform the work within those guardrails.
The documentation site is built with
[Starlight](https://starlight.astro.build), a documentation framework built on
[Astro](https://astro.build).

Expand Down
4 changes: 3 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# SuperPlane Documentation

This repository contains the documentation for [SuperPlane](https://github.com/superplanehq/superplane), the open source DevOps control plane.
This repository contains the documentation for [SuperPlane](https://github.com/superplanehq/superplane), an open source AI software factory for engineering teams. SuperPlane coordinates AI agents, source control, continuous integration (CI), review, approvals, and feedback to move high-confidence routine work from the backlog to verified, review-ready pull requests.

Agents perform the work. Workflows define the allowed scope, required checks, review policies, approval points, and escalation paths. This keeps control and verification in the workflow instead of depending on a specific model or agent.

## About

Expand Down
4 changes: 2 additions & 2 deletions scripts/generate-llms.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ function buildLlmsTxt(sections) {
const lines = [
"# SuperPlane Docs",
"",
"> SuperPlane documentation for building and operating event-driven DevOps workflows.",
"> SuperPlane documentation for building and operating AI agent workflows that one-shot routine engineering work.",
"",
"This file provides a structured index of documentation pages for LLM-based tools.",
"",
Expand All @@ -166,7 +166,7 @@ function buildLlmsFullTxt(sections) {
"",
"> Comprehensive companion to `/llms.txt` with full page content for the current docs table of contents.",
"",
"SuperPlane is an open source DevOps control plane for long-lived, event-driven workflows.",
"SuperPlane is an open source AI software factory that lets AI agents fully automate routine development work through long-lived, event-driven workflows.",
"",
];

Expand Down