Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions docs/mintlify/architecture.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ The system has nine distinct layers:
| **Harness Core** | Enforces contracts, validates evidence, manages run state and notifications (7 modules) |
| **Pipeline Engine** | Routes work through 15 canonical SDLC stages, each producing a typed artifact |
| **Governance + Security + Memory** | Approval gates, guardrails, secret scanning, injection detection, episodic memory |
| **Observability** | Live dashboard server (port 3005), run reporter, 19 tracked event types |
| **Observability** | Live dashboard server (port 3008), run reporter, 19 tracked event types |
| **Notifications & Handoff** | Slack/Discord/Teams webhooks; structured agent-to-agent context relay via `handoff.md` |
| **Asset Registry & Run State** | 196 agents Β· 156 skills Β· 72 plugins; resumable run state with checkpoint/rollback |

Expand Down Expand Up @@ -563,7 +563,7 @@ RStack ships a built-in enterprise observability stack. Three components work to

### `sdlc_dashboard` β€” Live HTML dashboard

Generates `dashboard.html` under the run directory and starts a local HTTP server (default port `3005`):
Generates `dashboard.html` under the run directory and starts a local HTTP server (default port `3008`):

```text
sdlc_dashboard()
Expand Down
15 changes: 7 additions & 8 deletions docs/mintlify/concepts/plugins-and-skills.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -133,14 +133,13 @@ Prompts are command-style workflow templates. They give the agent a scripted app

**Count:** 36 prompts included

```bash
rstack-agents list prompts
# Example:
# api-design.md
# database-migration.md
# release-checklist.md
# security-review.md
# ...
```text
prompts/
api-design.md
database-migration.md
release-checklist.md
security-review.md
...
```

Prompts are exposed as slash commands in Pi:
Expand Down
10 changes: 10 additions & 0 deletions docs/mintlify/docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,20 @@
{
"group": "Getting Started",
"pages": [
"getting-started/install-your-framework",
"getting-started/installation",
"getting-started/your-first-run",
"getting-started/governance-model"
]
},
{
"group": "Business Hub",
"pages": [
"reference/business-hub",
"reference/approvals",
"reference/webhooks"
]
},
{
"group": "Core Concepts",
"pages": [
Expand Down Expand Up @@ -73,6 +82,7 @@
"pages": [
"reference/cli",
"reference/pi-tools",
"reference/observability",
"reference/configuration",
"reference/protected-actions"
]
Expand Down
10 changes: 9 additions & 1 deletion docs/mintlify/getting-started/governance-model.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,15 @@ sdlc_approve(artifact="release-readiness.json", status="APPROVED")
sdlc_approve(artifact="destructive-action", status="APPROVED")
```

Approvals are written to `.rstack/runs/<run_id>/approvals.json` and referenced in traceability.
Approvals are written to `.rstack/runs/<run_id>/approvals.json` and referenced in traceability. The recorded approver is the resolved identity (git config or `RSTACK_USER`), not a placeholder.

### Enforce policy & manager roles

For team use you can require specific approvals in **every** mode (including
express) and restrict who may approve, via `.rstack/policy.json` plus the
`RSTACK_APPROVAL_TOKEN` / `RSTACK_MANAGER_USERS` settings. The moment a gate
blocks, every configured notification channel is paged. See
[Approvals & Policy](/reference/approvals) for the full model.

## Protected actions

Expand Down
178 changes: 178 additions & 0 deletions docs/mintlify/getting-started/install-your-framework.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,178 @@
---
title: "Install your framework"
description: "Set up your AI coding framework first, then add RStack to it."
---

RStack is a plugin, not a standalone app β€” it runs inside an AI coding
framework. This page gets you from nothing to a framework with RStack installed,
whichever tool you use. Every path ends the same way:

```bash
cd your-project
npm install rstack-agents
npx rstack-agents init # auto-detects your framework
```

<Info>
**Prerequisite for all frameworks:** Node.js 18 or newer (`node --version`).
RStack and its dashboard run on Node.
</Info>

## How well does each framework integrate?

| Framework | Integration | What you get |
|---|---|---|
| **Pi** | 🟒 Native adapter | All 15 `sdlc_*` tools, lifecycle hooks, gating, auto-launch dashboard |
| **Claude Code** | 🟒 First-class | `init` writes a usage guide + a SessionStart hook; plugin commands |
| **Operator** | 🟒 First-class | Python adapter bridges to the same harness; auto-launch dashboard |
| **Codex CLI** | 🟑 Asset-based | RStack agents/skills as context via `AGENTS.md`; no native tool gating |
| **Gemini CLI** | 🟑 Asset-based | RStack agents/skills as context via `GEMINI.md`; no native tool gating |
| **Any other harness** | 🟑 Universal | The `.rstack/` state contract + a Node bridge any tool can call |

🟒 = full governed harness. 🟑 = RStack guides the agent via shared context;
the dashboard, state, and CLI still work, but tool-level gating depends on the host.

---

## Pi

Pi is RStack's native home β€” the deepest integration.

<Steps>
<Step title="Install Pi">
Follow the Pi install guide for your platform, then confirm:
```bash
pi --version
```
</Step>
<Step title="Add RStack to your project">
```bash
cd your-project
npm install rstack-agents
npx rstack-agents init --framework pi
```
Pi auto-loads the RStack extension from the package β€” no manual wiring.
</Step>
<Step title="Start a run in your next Pi session">
```text
sdlc_start(goal="...")
```
</Step>
</Steps>

Details: [Pi adapter](/adapters/pi).

---

## Claude Code

<Steps>
<Step title="Install Claude Code">
Install the Claude Code CLI or IDE extension, then confirm with `claude --version`.
</Step>
<Step title="Add RStack + init">
```bash
cd your-project
npm install rstack-agents
npx rstack-agents init --framework claude-code
```
This writes `.claude/rstack-sdlc.md` (a usage guide) and a **SessionStart
hook** so the Business Hub opens every session. If you already have a
`.claude/settings.json`, RStack leaves a mergeable snippet instead of
overwriting it.
</Step>
<Step title="Install the plugin (optional, adds slash commands)">
```text
/plugin install sdlc-automation
```
Then drive the pipeline with `/sdlc-start`, `/sdlc-status`, `/sdlc-resume`.
</Step>
</Steps>

Details: [Claude Code adapter](/adapters/claude-code).

---

## Operator

<Steps>
<Step title="Install Operator + Node">
Operator is a Python harness. RStack's Operator adapter shells out to a
Node bridge, so you need `node` and `npx` on `PATH`.
</Step>
<Step title="Add RStack + init">
```bash
cd your-project
npm install rstack-agents
npx rstack-agents init --framework operator
```
`init` writes `rstack-operator.example.json`.
</Step>
<Step title="Wire the adapter into Operator settings">
Merge the `extensions.list` entry from `rstack-operator.example.json` into
your Operator `settings.json`. The Business Hub auto-launches when the
extension loads.
</Step>
</Steps>

Details: [Operator adapter](/adapters/universal).

---

## Codex CLI

Codex integrates through shared context files (no native tool binding yet).

<Steps>
<Step title="Install the Codex CLI">
Install per its docs and confirm it runs in your project.
</Step>
<Step title="Add RStack and bring in the assets">
```bash
cd your-project
npm install rstack-agents
npx rstack-agents init --framework custom
```
Then point Codex at the RStack agents via `AGENTS.md`. See the
[Codex adapter](/adapters/codex) for the exact `AGENTS.md` block.
</Step>
<Step title="Use the dashboard + CLI">
The Business Hub (`npx rstack-agents hub`) and `.rstack/` state work the
same as any framework.
</Step>
</Steps>

---

## Gemini CLI

Same asset-based pattern as Codex, via `GEMINI.md`.

<Steps>
<Step title="Install the Gemini CLI">
Install per its docs.
</Step>
<Step title="Add RStack + init (custom)">
```bash
cd your-project
npm install rstack-agents
npx rstack-agents init --framework custom
```
Add the RStack instructions to `GEMINI.md` β€” see the
[Gemini adapter](/adapters/gemini).
</Step>
</Steps>

---

## Any other framework

If your harness can read a project directory, it can use RStack. Install with
`--framework custom`, then either feed it the RStack agent context or have it
call the Node bridge per tool. Full contract:
[Universal / custom adapter](/adapters/universal).

<Tip>
Whatever framework you chose, your next stop is the same:
[Your first run](/getting-started/your-first-run).
</Tip>
30 changes: 25 additions & 5 deletions docs/mintlify/getting-started/installation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,33 @@ title: "Installation"
description: "All supported installation methods for RStack SDLC."
---

RStack can be installed in any AI coding environment. Choose the method that matches your runtime.
RStack can be installed in any AI coding environment.

## Requirements

- Node.js >= 18.0.0
- npm >= 9.0.0

## Recommended: one command for any framework

```bash
cd your-project
npm install rstack-agents
npx rstack-agents init # auto-detects pi | claude-code | operator | custom
```

`init` sets up `.rstack/`, registers the project with the Business Hub, writes
the framework-specific glue, and prints next steps β€” idempotent and
non-destructive. New to your AI framework itself? See
[Install your framework](/getting-started/install-your-framework) for the
per-tool setup, then run the command above.

<Tip>
The sections below are the **manual / asset-based** paths. You only need them
for frameworks without a native adapter (Codex, Gemini, universal) or if you
prefer wiring assets yourself.
</Tip>

## Pi β€” Native adapter (full-featured)

The native Pi adapter gives RStack lifecycle hooks, tool gating, session events, and the full governed harness.
Expand Down Expand Up @@ -130,8 +150,8 @@ rstack-agents validate

Expected output:
```
196 agents found
156 skills found
72 plugins found
βœ“ Validation passed
$ rstack-agents validate
[rstack] All 196 agents passed validation.
```

The catalog ships **196 agents, 156 skills, 72 plugins, 36 prompts**.
18 changes: 6 additions & 12 deletions docs/mintlify/introduction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,6 @@ title: "RStack SDLC"
description: "A framework-independent, governed AI software-delivery harness for coding agents."
---

<img
className="block dark:hidden"
src="/assets/hero-light.png"
alt="RStack SDLC"
/>

## What is RStack?

**RStack SDLC** is a portable AI-SDLC framework developed by Richardson Gunde. It gives AI coding agents a repeatable, governed software delivery lifecycle instead of ad-hoc prompting.
Expand All @@ -24,13 +18,13 @@ description: "A framework-independent, governed AI software-delivery harness for
Understand the Orchestrator β†’ Builder β†’ Validator model.
</Card>
<Card title="SDLC Pipeline" icon="arrow-right-arrow-left" href="/sdlc-pipeline/overview">
Explore all 14 pipeline agents from environment to cost estimation.
Explore all 15 pipeline agents from environment to cost estimation.
</Card>
<Card title="Adapters" icon="plug" href="/adapters/pi">
Install RStack in Pi, Claude Code, Codex, Gemini, and more.
<Card title="Install your framework" icon="plug" href="/getting-started/install-your-framework">
Set up Pi, Claude Code, Codex, Gemini CLI, or Operator β€” then add RStack.
</Card>
<Card title="Observability Hub" icon="chart-line" href="/reference/observability">
Live dashboard, CLI trace, and multi-channel webhook notifications.
<Card title="Business Hub" icon="chart-line" href="/reference/business-hub">
Live multi-project dashboard, Studio 3D, approvals, and webhooks on :3008.
</Card>
</CardGroup>

Expand All @@ -47,7 +41,7 @@ RStack enforces this lifecycle so AI agents behave like a productive software te
| Layer | Contents |
|---|---|
| `agents/core/` | Orchestrator, builder, and validator team contracts |
| `agents/sdlc/` | 14 full-lifecycle pipeline agents |
| `agents/sdlc/` | 15 full-lifecycle pipeline agents (stages 00–14) |
| `agents/specialists/` | Backend, frontend, devops, QA, security, data, docs specialists |
| `skills/` | 156 reusable workflow instructions |
| `prompts/` | 36 prompt templates and command-style workflows |
Expand Down
Loading
Loading