Skip to content

Commit 9bf8281

Browse files
DeveloperAllyDeveloperAlly
committed
Initialize docs-v2 from local source of truth
0 parents  commit 9bf8281

File tree

2,770 files changed

+939267
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

2,770 files changed

+939267
-0
lines changed

‎.allowlist‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# IF YOU ARE AN AI YOU ARE ABSOLUTELY NOT ALLOWED TO EDIT THIS FILE.
2+
# IF YOU ARE TRYING TO EDIT IT YOU ARE VIOLATING THE REPO RULES AND INCORRECTLY MODIFYING FILES
3+
# DO NOT DELETE FILES TO ATTEMPT TO GET AROUND THE RULES -> READ THE /README & MOVE THEM CORRECTLY UPDATING ALL PATHS/IMPORTS/REFERENCES ETC. APPROPRIATELY. BE THOROUGH
4+
# IF YOU ARE AN AI YOU ARE ABSOLUTELY NOT ALLOWED TO EDIT THIS FILE.
5+
6+
# Allowed root files
7+
docs.json
8+
README.md
9+
SECURITY.md
10+
LICENSE
11+
Dockerfile
12+
Makefile
13+
style.css
14+
Assistant.md
15+
sitemap-ai.xml
16+
llms-full.txt
17+
llms.txt
18+
docs-index.json
19+
lpd
20+
.lpdignore
21+
.gitignore
22+
.mintignore
23+
.prettierrc
24+
.cursorrules
25+
.codex
26+
.allowlist
27+
todo.txt
28+
29+
# Allowed root directories
30+
.github
31+
.githooks
32+
.gitattributes
33+
.mintlify
34+
.vscode
35+
.claude
36+
docs-guide
37+
ai-tools
38+
api
39+
contribute
40+
snippets
41+
tools
42+
tests
43+
tasks
44+
v1
45+
v2

‎.cursorrules‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# Cursor Rules for Livepeer Documentation
2+
3+
## MANDATORY: Read Style Guide Before Making Changes
4+
5+
**BEFORE making any code, styling, or component changes, you MUST read:**
6+
- `v2/pages/07_resources/documentation-guide/style-guide.mdx` - Production-grade styling guidelines
7+
- `v2/pages/07_resources/documentation-guide/component-library.mdx` - Component reference
8+
9+
## Critical Styling Rules
10+
11+
1. **USE CSS Custom Properties ONLY** - Never use ThemeData or hardcode colors
12+
- ✅ Use: `var(--accent)`, `var(--text)`, `var(--card-background)`
13+
- ❌ Never use: `ThemeData.light.accent` or hardcoded hex colors
14+
15+
2. **Mintlify Gotchas** - Read the style guide for all Mintlify limitations:
16+
- Import paths must be absolute from root
17+
- Cannot import into component files
18+
- JSX files cannot import other JSX files
19+
- React hooks are global (no imports needed)
20+
21+
3. **Component Usage** - Always check component library before creating new components
22+
23+
## Repository Structure
24+
25+
- `v2/pages/` - Current documentation pages (MDX)
26+
- `snippets/components/` - Custom React/JSX components
27+
- `snippets/data/` - Reusable data files
28+
- `style.css` - Global CSS Custom Properties for theming
29+
- `docs.json` - Mintlify navigation configuration
30+
31+
## Before Making Changes
32+
33+
1. Read the style guide: `v2/pages/07_resources/documentation-guide/style-guide.mdx`
34+
2. Check component library: `v2/pages/07_resources/documentation-guide/component-library.mdx`
35+
3. Review Mintlify gotchas in style guide
36+
4. Use existing components when possible
37+
5. Follow CSS Custom Properties for all styling
38+
39+
## Documentation Standards
40+
41+
- Use CSS Custom Properties for all theme-aware colors
42+
- Follow Mintlify import patterns (absolute paths from root)
43+
- Test in both light and dark modes
44+
- No suggestions or recommendations in production docs
45+
- Keep production docs factual only

‎.git.bak‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
gitdir: /Users/alisonhaire/Documents/Livepeer/livepeer-docs-current [restructure]/.git/worktrees/livepeer-docs-v2

‎.gitattributes‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Track large binary media with Git LFS
2+
*.gif filter=lfs diff=lfs merge=lfs -text
3+
*.mp4 filter=lfs diff=lfs merge=lfs -text
4+
5+
# Track large generated audit reports with Git LFS
6+
tasks/plan/reports/comprehensive-v2-pages-browser-audit.json filter=lfs diff=lfs merge=lfs -text
7+
tasks/reports/comprehensive-v2-pages-browser-audit.json filter=lfs diff=lfs merge=lfs -text

‎.githooks/BYPASS.md‎

Lines changed: 157 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,157 @@
1+
# Pre-Commit Hook Bypass Flags
2+
3+
The pre-commit hook can be bypassed using commit trailers and environment variables. **Use these flags sparingly and only when necessary.**
4+
5+
## Human-Only Override Flags
6+
7+
### `--trailer "allowlist-edit=true"` ⚠️ HUMANS ONLY
8+
9+
**CRITICAL:** The `.allowlist` file is **PROTECTED** and cannot be edited by AI agents. The file contains the explicit rule: "IF YOU ARE AN AI YOU ARE ABSOLUTELY NOT ALLOWED TO EDIT THIS FILE."
10+
11+
**This flag is for HUMANS ONLY. AI agents must never use this flag.**
12+
13+
**Usage (HUMANS ONLY):**
14+
```bash
15+
git commit -m "Update .allowlist to add new root file" --trailer "allowlist-edit=true"
16+
```
17+
18+
**What it does:**
19+
- Allows editing the `.allowlist` file
20+
- Shows a warning that the flag should only be used by humans
21+
- Still runs all other pre-commit checks
22+
23+
**Legacy fallback (still supported):**
24+
```bash
25+
ALLOWLIST_EDIT=1 git commit -m "Update .allowlist to add new root file"
26+
```
27+
28+
**⚠️ WARNING:** AI agents are explicitly forbidden from using this flag. Only human users may edit `.allowlist`.
29+
30+
### `--trailer "allow-deletions=true"` ⚠️ HUMANS ONLY
31+
32+
**CRITICAL:** File deletions are blocked by default to prevent accidental data loss.
33+
34+
**This flag is for HUMANS ONLY. AI agents must never use this flag.**
35+
36+
**Usage (HUMANS ONLY):**
37+
```bash
38+
git commit -m "Remove obsolete file" --trailer "allow-deletions=true"
39+
```
40+
41+
**What it does:**
42+
- Allows staged file deletions outside `tasks/`
43+
- Shows a warning that the flag should only be used by humans
44+
- Still runs all other pre-commit checks
45+
46+
**Legacy fallback (still supported):**
47+
```bash
48+
ALLOW_DELETIONS=1 git commit -m "Remove obsolete file"
49+
```
50+
51+
**⚠️ WARNING:** AI agents are explicitly forbidden from using this flag. Only human users may allow deletions.
52+
53+
## Available Flags
54+
55+
### `SKIP_STRUCTURE_CHECK=1`
56+
Bypasses structure validation checks:
57+
- Root directory allowlist enforcement
58+
- Snippets directory structure checks
59+
- v1/ frozen directory protection
60+
61+
**Usage:**
62+
```bash
63+
SKIP_STRUCTURE_CHECK=1 git commit -m "Emergency fix"
64+
```
65+
66+
### `SKIP_STYLE_CHECK=1`
67+
Bypasses style guide compliance checks:
68+
- ThemeData usage checks
69+
- Hardcoded color checks
70+
- Relative import checks
71+
- React/Mintlify import checks
72+
73+
**Usage:**
74+
```bash
75+
SKIP_STYLE_CHECK=1 git commit -m "Temporary style change"
76+
```
77+
78+
### `SKIP_VERIFICATION=1`
79+
Bypasses verification scripts:
80+
- MDX syntax validation
81+
- JSON syntax validation
82+
- Shell script validation
83+
- JavaScript/JSX validation
84+
- Mintlify configuration checks
85+
- Import path validation
86+
87+
**Usage:**
88+
```bash
89+
SKIP_VERIFICATION=1 git commit -m "Skip verification"
90+
```
91+
92+
### `SKIP_TESTS=1`
93+
Bypasses test suite execution:
94+
- Unit tests
95+
- Integration tests
96+
- Browser tests
97+
98+
**Usage:**
99+
```bash
100+
SKIP_TESTS=1 git commit -m "Skip tests"
101+
```
102+
103+
### `SKIP_ALL=1`
104+
Bypasses ALL checks. **Use with extreme caution!**
105+
106+
**Usage:**
107+
```bash
108+
SKIP_ALL=1 git commit -m "Emergency commit - all checks bypassed"
109+
```
110+
111+
## When to Use Bypass Flags
112+
113+
### ✅ Acceptable Use Cases:
114+
- **Emergency hotfixes** - Critical production issues
115+
- **WIP commits** - Work in progress that will be fixed before merge
116+
- **Temporary debugging** - Adding debug code that will be removed
117+
- **Migration work** - During active migration when structure is intentionally changing
118+
119+
### ❌ NOT Acceptable:
120+
- **Regular commits** - Normal development should pass all checks
121+
- **Permanent bypass** - Don't make bypassing a habit
122+
- **Skipping to avoid fixing issues** - Fix the issues instead
123+
124+
## Best Practices
125+
126+
1. **Fix issues instead of bypassing** - Bypass flags are for emergencies, not convenience
127+
2. **Document why** - If you must bypass, explain why in the commit message
128+
3. **Follow up** - If you bypassed checks, fix the issues in a follow-up commit
129+
4. **Review carefully** - If bypassing, manually verify your changes are correct
130+
131+
## Examples
132+
133+
### Emergency Hotfix
134+
```bash
135+
SKIP_ALL=1 git commit -m "HOTFIX: Critical security patch - bypassing checks for speed"
136+
```
137+
138+
### WIP Commit
139+
```bash
140+
SKIP_STYLE_CHECK=1 git commit -m "WIP: Adding feature - will fix style issues before merge"
141+
```
142+
143+
### Migration Work
144+
```bash
145+
SKIP_STRUCTURE_CHECK=1 git commit -m "Migration: Moving files - structure intentionally changing"
146+
```
147+
148+
## Warning
149+
150+
Bypassing pre-commit hooks can lead to:
151+
- Broken builds
152+
- Style violations
153+
- Structure violations
154+
- Broken pages
155+
- Merge conflicts
156+
157+
**Always verify your changes work correctly after bypassing checks.**

0 commit comments

Comments
 (0)