Skip to content

Commit 7fa745c

Browse files
committed
Refactor DEVELOPMENT.md and README.md for clarity and structure
- Removed outdated local run instructions from DEVELOPMENT.md and streamlined the useful paths section. - Enhanced README.md by consolidating preview sections and reintroducing local run instructions for better visibility. - Improved overall formatting and organization to facilitate easier navigation for contributors.
1 parent fab6bcc commit 7fa745c

File tree

2 files changed

+33
-45
lines changed

2 files changed

+33
-45
lines changed

apps/academy/DEVELOPMENT.md

Lines changed: 8 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -18,34 +18,19 @@ That file is the design-system reference (colors, typography, shadows, layout, c
1818

1919
---
2020

21-
## Run locally
22-
23-
From the **repository root** (npm workspaces):
24-
25-
```bash
26-
npm install
27-
cd apps/academy
28-
npm run dev
29-
```
30-
31-
Open [http://localhost:3000](http://localhost:3000).
32-
33-
- **Node:** **24** matches root `package.json` `engines` (e.g. `mise install`, then `mise exec -- npm run dev` if you do not use 24 globally).
34-
- **`dev` script:** runs `prebuild` (ruleset extraction + source extraction) before `next dev`.
21+
## Useful paths
3522

36-
---
3723

38-
## Useful paths
24+
| Path | Purpose |
25+
| ----------------------- | ------------------------------------------------------------ |
26+
| `src/app/` | Next.js App Router routes and layouts |
27+
| `src/components/` | UI and layout components |
28+
| `docs/design/DESIGN.md` | Visual design contract |
29+
| `images/` | Readme / marketing screenshots (e.g. `academy-readme-*.png`) |
3930

40-
| Path | Purpose |
41-
| ---- | ------- |
42-
| `src/app/` | Next.js App Router routes and layouts |
43-
| `src/components/` | UI and layout components |
44-
| `docs/design/DESIGN.md` | Visual design contract |
45-
| `images/` | Readme / marketing screenshots (e.g. `academy-readme-*.png`) |
4631

4732
---
4833

4934
## Workspace reference
5035

51-
Repo-wide conventions: **[AGENTS.md](../../AGENTS.md)** at the monorepo root (structure, Rust/TS norms, CI expectations). The Academy-specific UI rule above stays authoritative for this app’s look and feel.
36+
Repo-wide conventions: **[AGENTS.md](../../AGENTS.md)** at the monorepo root (structure, Rust/TS norms, CI expectations). The Academy-specific UI rule above stays authoritative for this app’s look and feel.

apps/academy/README.md

Lines changed: 25 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -15,27 +15,30 @@
1515

1616
## Preview
1717

18-
<p align="center">
19-
<strong>Landing</strong> — hero, tracks, and calls to action
20-
</p>
21-
<p align="center">
22-
<img
23-
src="./images/academy-readme-landing.png"
24-
alt="ClawdStrike Academy landing: hero and learning tracks"
25-
width="1100"
26-
/>
27-
</p>
28-
29-
<p align="center">
30-
<strong>Guard Gallery</strong> — browse guards by tier
31-
</p>
32-
<p align="center">
33-
<img
34-
src="./images/academy-readme-guard-gallery.png"
35-
alt="ClawdStrike Academy Guard Gallery overview"
36-
width="1100"
37-
/>
38-
</p>
18+
**Landing** — hero, tracks, and calls to action
19+
20+
21+
22+
**Guard Gallery** — browse guards by tier
23+
24+
25+
26+
---
27+
28+
## Run locally
29+
30+
From the **repository root** (npm workspaces):
31+
32+
```bash
33+
npm install
34+
cd apps/academy
35+
npm run dev
36+
```
37+
38+
Open [http://localhost:3000](http://localhost:3000).
39+
40+
- **Node:** **24** matches root `package.json` `engines` (e.g. `mise install`, then `mise exec -- npm run dev` if you do not use 24 globally).
41+
- `dev` **script:** runs `prebuild` (ruleset extraction + source extraction) before `next dev`.
3942

4043
---
4144

@@ -49,4 +52,4 @@ ClawdStrike is the wider **policy, receipts, and enforcement** system this Acade
4952

5053
If you are **developing this app**, running it locally, or you are an **AI agent** changing UI or behavior, use the dedicated guide — it holds setup commands, design rules, and repo-specific notes:
5154

52-
**[→ Development guide (Contributors & agents)](./DEVELOPMENT.md)**
55+
**[→ Development guide (Contributors & agents)](./DEVELOPMENT.md)**

0 commit comments

Comments
 (0)