You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
# Story 11.3: Distribute and Document `devrail init`
2
2
3
-
Status: backlog
3
+
Status: done
4
4
5
5
## Story
6
6
@@ -10,47 +10,93 @@ so that I can adopt DevRail in my project without reading the full standards fir
10
10
11
11
## Acceptance Criteria
12
12
13
-
1.The `devrail init` script is available via a simple install command (curl, npm, pip, or similar)
13
+
1.`curl -fsSL https://devrail.dev/init.sh | bash` downloads and runs `devrail init`
14
14
2. Installation instructions are documented on devrail.dev
15
-
3. A getting-started guide walks through the full adoption flow
16
-
4. The devrail.dev site includes a "Quick Start" page with `devrail init` as the entry point
17
-
5.`make check` passes on all updated repos
15
+
3. The existing getting-started guides are updated to reference `devrail init` as the primary adoption path
16
+
4. The devrail.dev Getting Started index page leads with `devrail init` as the entry point
17
+
5. CLI reference documentation exists for all `devrail init` options
18
+
6.`make check` passes on all updated repos
18
19
19
20
## Tasks / Subtasks
20
21
21
-
-[] Task 1: Set up distribution (AC: 1)
22
-
-[] 1.1 Choose distribution mechanism based on 11.1 design
23
-
-[] 1.2 Publish the script/package to the chosen registry
24
-
-[] 1.3 Test installation from scratch on a clean system
22
+
-[x] Task 1: Set up curl-pipe-bash distribution via devrail.dev (AC: 1)
23
+
-[x] 1.1 Add `static/_redirects` file to `devrail.dev` Hugo site with redirect: `/init.sh` → `https://raw.githubusercontent.com/devrail-dev/dev-toolchain/main/scripts/devrail-init.sh 302`
24
+
-[x] 1.2 Deploy and verify `curl -fsSL https://devrail.dev/init.sh | bash -- --help` works
25
+
-[x] 1.3 Test in a fresh temp directory: `curl -fsSL https://devrail.dev/init.sh | bash -- --all --languages python --ci github --yes`
25
26
26
-
-[] Task 2: Write documentation (AC: 2, 3, 4)
27
-
-[] 2.1 Add install instructions to devrail.dev
28
-
-[] 2.2 Write getting-started guide covering all three adoption paths
- Small files embedded as heredocs; Makefile and DEVELOPMENT.md downloaded at runtime from `raw.githubusercontent.com/devrail-dev/github-repo-template/main/`
45
+
- The script header already references `curl -fsSL https://devrail.dev/init.sh | bash` — this URL doesn't work yet (primary deliverable of this story)
46
+
47
+
### Distribution Mechanism
48
+
49
+
Cloudflare Pages (which hosts devrail.dev) supports a `_redirects` file in the site root. Hugo serves static files from the `static/` directory. Add `static/_redirects` to redirect `/init.sh` to the raw GitHub script URL. This keeps a single source of truth (the script in dev-toolchain) without manual sync.
50
+
51
+
### Devrail.dev Site Context
52
+
53
+
- Hugo site with Docsy theme, repo at `github.com/devrail-dev/devrail.dev`
54
+
- Deploys via GitHub Actions to Cloudflare Pages
55
+
- Hugo URL pattern: `/:year/:month/:title/` (not filename-based) — important for blog post links
0 commit comments