Skip to content

Commit e15710f

Browse files
authored
Merge pull request #71 from eqtylab/markdown-improvements
2 parents a4612b7 + 243542f commit e15710f

13 files changed

Lines changed: 86 additions & 79 deletions

File tree

docs/docs/assets/cupcake-dark.svg

Lines changed: 1 addition & 1 deletion
Loading

docs/docs/assets/cupcake-light.svg

Lines changed: 1 addition & 1 deletion
Loading

docs/docs/assets/cupcake-responsive.svg

Lines changed: 1 addition & 1 deletion
Loading

docs/docs/assets/factory-dark.svg

Lines changed: 1 addition & 0 deletions
Loading

docs/docs/assets/factory-light.svg

Lines changed: 1 addition & 0 deletions
Loading

docs/docs/assets/factory.svg

Lines changed: 0 additions & 1 deletion
This file was deleted.

docs/docs/getting-started/installation.md

Lines changed: 34 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,6 @@ heading: "Installation"
44
description: "Install Cupcake on your system"
55
---
66

7-
## Quick Install
8-
97
Install Cupcake using the official install scripts:
108

119
### Unix/macOS
@@ -33,48 +31,52 @@ If you prefer to install manually or need a specific version, you can download p
3331

3432
### Install OPA
3533

36-
#### macOS
34+
???+ info "Install OPA"
3735

38-
```bash
39-
brew install opa
40-
```
36+
=== "macOS"
4137

42-
Or download directly:
38+
Using Homebrew
4339

44-
```bash
45-
# Apple Silicon (M1/M2/M3)
46-
curl -L -o opa https://openpolicyagent.org/downloads/latest/opa_darwin_arm64
40+
```bash
41+
brew install opa
42+
```
4743

48-
# Intel Macs
49-
curl -L -o opa https://openpolicyagent.org/downloads/latest/opa_darwin_amd64
44+
Or download directly:
5045

51-
chmod 755 opa
52-
sudo mv opa /usr/local/bin/
53-
```
46+
```bash
47+
# Apple Silicon (M1/M2/M3)
48+
curl -L -o opa https://openpolicyagent.org/downloads/latest/opa_darwin_arm64
5449

55-
#### Linux
50+
# Intel Macs
51+
curl -L -o opa https://openpolicyagent.org/downloads/latest/opa_darwin_amd64
5652

57-
```bash
58-
# AMD64
59-
curl -L -o opa https://openpolicyagent.org/downloads/latest/opa_linux_amd64
53+
chmod 755 opa
54+
sudo mv opa /usr/local/bin/
55+
```
6056

61-
# ARM64
62-
curl -L -o opa https://openpolicyagent.org/downloads/latest/opa_linux_arm64
57+
=== "Linux"
6358

64-
chmod 755 opa
65-
sudo mv opa /usr/local/bin/
66-
```
59+
```bash
60+
# AMD64
61+
curl -L -o opa https://openpolicyagent.org/downloads/latest/opa_linux_amd64
6762

68-
#### Windows (PowerShell)
63+
# ARM64
64+
curl -L -o opa https://openpolicyagent.org/downloads/latest/opa_linux_arm64
6965

70-
```powershell
71-
Invoke-WebRequest -Uri "https://openpolicyagent.org/downloads/latest/opa_windows_amd64.exe" -OutFile "opa.exe"
66+
chmod 755 opa
67+
sudo mv opa /usr/local/bin/
68+
```
7269

73-
# Add to PATH (run as Administrator or add to user PATH)
74-
mkdir C:\Tools\OPA
75-
move opa.exe C:\Tools\OPA\
76-
[Environment]::SetEnvironmentVariable("Path", "$env:Path;C:\Tools\OPA", "User")
77-
```
70+
=== "Windows (PowerShell)"
71+
72+
```powershell
73+
Invoke-WebRequest -Uri "https://openpolicyagent.org/downloads/latest/opa_windows_amd64.exe" -OutFile "opa.exe"
74+
75+
# Add to PATH (run as Administrator or add to user PATH)
76+
mkdir C:\Tools\OPA
77+
move opa.exe C:\Tools\OPA\
78+
[Environment]::SetEnvironmentVariable("Path", "$env:Path;C:\Tools\OPA", "User")
79+
```
7880

7981
#### Verify OPA Installation
8082

docs/docs/getting-started/usage/cursor.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: "Setting up Cupcake with Cursor"
55

66
# Cursor Setup
77

8-
**Important**: Cursor only supports **global** hooks (not project-level). All hooks are configured at `~/.cursor/hooks.json`.
8+
Cursor only supports **global** hooks (not project-level). All hooks are configured at `~/.cursor/hooks.json`.
99

1010
## Project Setup with Global Hooks
1111

docs/docs/getting-started/usage/index.md

Lines changed: 10 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -9,42 +9,18 @@ After [installation](../installation/), you're ready to set up Cupcake for your
99

1010
## Select Your Harness
1111

12-
<div style="display: grid; grid-template-columns: repeat(auto-fit, minmax(140px, 1fr)); gap: 1.5rem; margin: 2rem 0;">
13-
<a href="claude-code/" style="text-decoration: none; color: inherit;">
14-
<div style="border: 1px solid var(--md-default-fg-color--lightest); border-radius: 8px; padding: 1.5rem; text-align: center;">
15-
<img src="../../assets/claude-light.svg#only-light" alt="Claude Code" width="100">
16-
<img src="../../assets/claude-dark.svg#only-dark" alt="Claude Code" width="100">
17-
</div>
18-
</a>
19-
<a href="cursor/" style="text-decoration: none; color: inherit;">
20-
<div style="border: 1px solid var(--md-default-fg-color--lightest); border-radius: 8px; padding: 1.5rem; text-align: center;">
21-
<img src="../../assets/cursor-light.svg#only-light" alt="Cursor" width="100">
22-
<img src="../../assets/cursor-dark.svg#only-dark" alt="Cursor" width="100">
23-
</div>
24-
</a>
25-
<a href="opencode/" style="text-decoration: none; color: inherit;">
26-
<div style="border: 1px solid var(--md-default-fg-color--lightest); border-radius: 8px; padding: 1.5rem; text-align: center;">
27-
<img src="../../assets/opencode-wordmark-light.svg#only-light" alt="OpenCode" width="100">
28-
<img src="../../assets/opencode-wordmark-dark.svg#only-dark" alt="OpenCode" width="100">
29-
</div>
30-
</a>
31-
<a href="factory-ai/" style="text-decoration: none; color: inherit;">
32-
<div style="border: 1px solid var(--md-default-fg-color--lightest); border-radius: 8px; padding: 1.5rem; text-align: center;">
33-
<img src="../../assets/factory.svg" alt="Factory AI" width="100">
34-
</div>
35-
</a>
36-
</div>
37-
38-
| Harness | Status | Guide |
39-
| --------------- | --------------- | --------------------------- |
40-
| **Claude Code** | Fully Supported | [Setup Guide](claude-code/) |
41-
| **Cursor** | Fully Supported | [Setup Guide](cursor/) |
42-
| **OpenCode** | Fully Supported | [Setup Guide](opencode/) |
43-
| **Factory AI** | Fully Supported | [Setup Guide](factory-ai/) |
12+
<!-- If you update this table you should also update it on the homepage! -->
13+
14+
| Harness | Status | Guide |
15+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------ | ----------------------------- |
16+
| <img src="../../assets/claude-light.svg#only-light" alt="Claude Code" width="90"><img src="../../assets/claude-dark.svg#only-dark" width="90" aria-hidden="true"> | :lucide-check: Fully Supported | [Setup Guide](claude-code.md) |
17+
| <img src="../../assets/cursor-light.svg#only-light" alt="Cursor" width="90"><img src="../../assets/cursor-dark.svg#only-dark" width="90" aria-hidden="true"> | :lucide-check: Fully Supported | [Setup Guide](cursor.md) |
18+
| <img src="../../assets/opencode-wordmark-light.svg#only-light" alt="OpenCode" width="90"><img src="../../assets/opencode-wordmark-dark.svg#only-dark" width="90" aria-hidden="true"> | :lucide-check: Fully Supported | [Setup Guide](opencode.md) |
19+
| <img src="../../assets/factory-light.svg#only-light" alt="Factory AI" width="100"><img src="../../assets/factory-dark.svg#only-dark" width="100" aria-hidden="true"> | :lucide-check: Fully Supported | [Setup Guide](factory-ai.md) |
4420

4521
## Next Steps
4622

4723
After setting up your harness, learn how to configure policies:
4824

49-
- **[Built-in Policies](../../reference/policies/builtins/)** — Enable pre-built security policies
50-
- **[Custom Policies](../../reference/policies/custom/)** — Write your own policies in Rego
25+
- **[Built-in Policies](../../reference/policies/builtins.md)** — Enable pre-built security policies
26+
- **[Custom Policies](../../reference/policies/custom.md)** — Write your own policies in Rego

0 commit comments

Comments
 (0)