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
7 changes: 0 additions & 7 deletions docs/getting-started/compatible-agents.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,10 +76,3 @@ Read RUP-FLOW.md and use rup-flow to document this system in docs/rup.

An agent that cannot run commands can still write the documents by following the
references, but it cannot render or check them; it must say so.

## What is tested

The automated tests check that every target writes its file, keeps the rest of an
existing file, does not duplicate its block, and that the skill installs into both
skill folders. What an agent does with the files is up to the agent; report a client
that ignores them.
12 changes: 6 additions & 6 deletions docs/getting-started/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Unzip so that the folder lands inside the skills folder of your agent.
=== "Claude Code"

```console
unzip rup-flow-free-1.0.0.zip -d ~/.claude/skills
unzip rup-flow-free-1.0.1.zip -d ~/.claude/skills
```

Use `.claude/skills` inside a project to install it for that project only. Then
Expand All @@ -50,7 +50,7 @@ Unzip so that the folder lands inside the skills folder of your agent.
=== "Codex, Gemini CLI and others"

```console
unzip rup-flow-free-1.0.0.zip -d ~/.agents/skills
unzip rup-flow-free-1.0.1.zip -d ~/.agents/skills
```

Clients that read `.agents/skills` pick it up. Say "Use rup-flow to ...".
Expand All @@ -60,13 +60,13 @@ Unzip so that the folder lands inside the skills folder of your agent.
Every client lists its own skills folder in its documentation. Unzip there:

```console
unzip rup-flow-free-1.0.0.zip -d <skills folder of your client>
unzip rup-flow-free-1.0.1.zip -d <skills folder of your client>
```

On Windows, use the file manager or `Expand-Archive`:

```console
Expand-Archive rup-flow-free-1.0.0.zip -DestinationPath $HOME\.claude\skills
Expand-Archive rup-flow-free-1.0.1.zip -DestinationPath $HOME\.claude\skills
```

## Agents that read an instruction file
Expand All @@ -88,8 +88,8 @@ node <skills folder>/rup-flow/scripts/rup.mjs version
node <skills folder>/rup-flow/scripts/rup.mjs editions
```

`version` prints `rup-flow free 1.0.0` or `rup-flow Pro 1.0.0 (built on rup-flow
free 1.0.0)`. `editions` lists what the installation includes; the first line says
`version` prints `rup-flow free 1.0.1` or `rup-flow Pro 1.0.1 (built on rup-flow
free 1.0.1)`. `editions` lists what the installation includes; the first line says
`free` or `Pro`.

## Update
Expand Down
4 changes: 2 additions & 2 deletions docs/pro/get-pro.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ way as the free edition ([installation](../getting-started/installation.md)):
=== "Claude Code"

```console
unzip rup-flow-pro-1.0.0.zip -d ~/.claude/skills
unzip rup-flow-pro-1.0.1.zip -d ~/.claude/skills
```

Copy the files of `rup-flow-pro/agents` to `~/.claude/agents` to enable the
Expand All @@ -42,7 +42,7 @@ way as the free edition ([installation](../getting-started/installation.md)):
=== "Codex, Gemini CLI and others"

```console
unzip rup-flow-pro-1.0.0.zip -d ~/.agents/skills
unzip rup-flow-pro-1.0.1.zip -d ~/.agents/skills
```

=== "Instruction-file agents"
Expand Down
4 changes: 2 additions & 2 deletions docs/pro/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,8 +89,8 @@ independently.

## How Pro is versioned

Pro has its own version, `1.0.0` today, and always states the free version it
contains: `rup.mjs version` prints `rup-flow Pro 1.0.0 (built on rup-flow free 1.0.0)`.
Pro has its own version, `1.0.1` today, and always states the free version it
contains: `rup.mjs version` prints `rup-flow Pro 1.0.1 (built on rup-flow free 1.0.1)`.
Pages and rows of this site marked <span class="rup-pro-tag">Pro</span> say since
which Pro version they apply. See [Pro versions and compatibility](versions.md).

Expand Down
11 changes: 9 additions & 2 deletions docs/pro/versions.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,15 @@ skill and states which one:

```console
RUP version
rup-flow Pro 1.0.0 (built on rup-flow free 1.0.0)
rup-flow Pro 1.0.1 (built on rup-flow free 1.0.1)
```

## Compatibility

| Pro | Contains free | Documentation line |
| --- | --- | --- |
| 1.0.x | 1.0.x | 1.0 |
| 1.0.1 | 1.0.1 | 1.0 |
| 1.0.0 | 1.0.0 | 1.0 |

The documentation line is the free edition's `MAJOR.MINOR`; a Pro release is documented
on the line of the free version it contains. Pages and rows marked
Expand All @@ -28,6 +29,12 @@ after Pro 1.0.

## Pro changelog

### 1.0.1

Built on rup-flow free 1.0.1.

- `init` creates the project root when it does not exist instead of failing with a stack trace.

### 1.0.0

First release of rup-flow Pro, built on rup-flow free 1.0.0.
Expand Down
4 changes: 2 additions & 2 deletions docs/reference/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -144,8 +144,8 @@ RUP version
RUP editions --json
```

`version` prints `rup-flow free 1.0.0`, or for Pro `rup-flow Pro 1.0.0 (built on
rup-flow free 1.0.0)`. With `--json` it prints the edition and versions as JSON.
`version` prints `rup-flow free 1.0.1`, or for Pro `rup-flow Pro 1.0.1 (built on
rup-flow free 1.0.1)`. With `--json` it prints the edition and versions as JSON.
`editions` prints the catalogue as a checklist of what the installation includes.

## `server`
Expand Down
6 changes: 6 additions & 0 deletions docs/releases/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,12 @@ Changes of the free skill. The format follows [Keep a Changelog](https://keepach

## Unreleased

## 1.0.1

### Fixed

- `init` creates the project root when it does not exist instead of failing with a stack trace.

## 1.0.0

First release of the free edition from a clean history. It turns requirements into a basic RUP documentation set with PlantUML diagrams for any coding agent.
Expand Down
2 changes: 1 addition & 1 deletion docs/releases/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Releases
description: Choose the correct rup-flow documentation, understand how the free and Pro versions map and trace immutable releases.
application_line: "1.0"
validated_application_version: "1.0.0"
validated_application_version: "1.0.1"
---

# Releases
Expand Down
10 changes: 5 additions & 5 deletions docs/releases/versioning.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,14 +17,14 @@ Four numbers answer four different questions:

```console
RUP version
rup-flow free 1.0.0
rup-flow free 1.0.1

RUP version
rup-flow Pro 1.0.0 (built on rup-flow free 1.0.0)
rup-flow Pro 1.0.1 (built on rup-flow free 1.0.1)
```

The same number is in the name of the package, `rup-flow-free-1.0.0.zip` or
`rup-flow-pro-1.0.0.zip`, and in the `metadata.version` of `SKILL.md`.
The same number is in the name of the package, `rup-flow-free-1.0.1.zip` or
`rup-flow-pro-1.0.1.zip`, and in the `metadata.version` of `SKILL.md`.

## How the editions map

Expand All @@ -42,7 +42,7 @@ Compatible patches update the same line instead of creating a new copy of the si

```text
Edition line: 1.0.x
Validated version: 1.0.0
Validated version: 1.0.1
Version selector: 1.0
Canonical path: /rup-flow-docs/1.0/
```
Expand Down
4 changes: 2 additions & 2 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -93,8 +93,8 @@ extra:
documentation_root: *documentation_root
social:
- icon: fontawesome/brands/github
link: https://github.com/hector-ae21/rup-flow
name: rup-flow on GitHub
link: https://github.com/hector-ae21/rup-flow-docs
name: rup-flow documentation on GitHub
version:
provider: mike
default: latest
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,6 @@
"playwright": "1.64.1"
},
"rupFlow": {
"version": "1.0.0"
"version": "1.0.1"
}
}
Loading