Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
65 commits
Select commit Hold shift + click to select a range
5c13e42
feat(about): add missing Network pages (marketplace, technical-archit…
DeveloperAlly Feb 16, 2026
a1a7608
feat(platforms): add full Livepeer Studio section under Platforms
DeveloperAlly Feb 16, 2026
35e71e3
Merge pull request #2 from DeveloperAlly/feature/orchestrators-v2-fil…
DeveloperAlly Feb 16, 2026
87530ae
Add docs/PLAN: 18 agent briefs for parallel execution
DeveloperAlly Feb 16, 2026
30f5f09
Merge pull request #3 from DeveloperAlly/docs-plan/agent-briefs
DeveloperAlly Feb 16, 2026
a2d76b7
docs/PLAN: Set docs-v2-preview as main branch (create-from and PR tar…
DeveloperAlly Feb 16, 2026
aadae1d
Merge pull request #4 from DeveloperAlly/docs-plan/agent-briefs
DeveloperAlly Feb 16, 2026
b0dc801
feat(styling): homogenise styling across repo
DeveloperAlly Feb 16, 2026
281f6e2
Add Task 02: Unused Components Audit Report
DeveloperAlly Feb 16, 2026
394369c
feat(styling): homogenise styling across repo
DeveloperAlly Feb 16, 2026
3e3fd0a
feat(components): consolidate components with documentation and examples
DeveloperAlly Feb 16, 2026
e39bb8b
Task 14: V1 to V2 documentation coverage audit report
DeveloperAlly Feb 16, 2026
992b7cc
Task 14: V1 to V2 documentation coverage audit report
DeveloperAlly Feb 16, 2026
99e38db
refactor(components): remove ThemeData imports, use global CSS variables
DeveloperAlly Feb 16, 2026
8fcdc4b
refactor(components): remove all ThemeData imports, use global CSS va…
DeveloperAlly Feb 16, 2026
945c8ab
feat(docs): add comprehensive component library wiki
DeveloperAlly Feb 16, 2026
bc1425b
Update Task 14 report: Add Livepeer Studio section recommendations
DeveloperAlly Feb 16, 2026
16d5e92
Update Task 14 report: Add Livepeer Studio section recommendations
DeveloperAlly Feb 16, 2026
77d0de3
refactor(components): remove all ThemeData imports, use global CSS va…
DeveloperAlly Feb 16, 2026
d71d201
refactor(components): remove all ThemeData imports, use global CSS va…
DeveloperAlly Feb 16, 2026
70fe13e
Consolidate duplicate components
DeveloperAlly Feb 16, 2026
83a31f1
Update Task 14 report: Identify existing placeholder pages
DeveloperAlly Feb 16, 2026
fda4f60
Update Task 14 report: Identify existing placeholder pages
DeveloperAlly Feb 16, 2026
081eda2
feat(platforms): add full Livepeer Studio section to docs-v2-preview
DeveloperAlly Feb 16, 2026
7089a8c
chore: merge all local changes - gateways, developers, docs, ai-pipel…
DeveloperAlly Feb 16, 2026
c368e5f
Consolidate Livepeer Studio section
DeveloperAlly Feb 16, 2026
6a389d5
Fix broken links in getting-started overview
DeveloperAlly Feb 16, 2026
2101f0e
Add consolidation summary report
DeveloperAlly Feb 16, 2026
a6dc5c0
Merge branch 'docs-v2-preview' of https://github.com/DeveloperAlly/li…
DeveloperAlly Feb 16, 2026
a6ddcc2
Organize Livepeer Studio root files into proper structure
DeveloperAlly Feb 16, 2026
c0c5379
Add file organization summary report
DeveloperAlly Feb 16, 2026
e201611
Move all root files to overview/ section
DeveloperAlly Feb 16, 2026
4543938
Fix broken links after moving files to overview/ section
DeveloperAlly Feb 16, 2026
56a29d6
Merge component library wiki from docs-plan/03-component-library-wiki
DeveloperAlly Feb 16, 2026
5df0206
Merge docs-plan/14-consolidate-livepeer-studio into docs-v2-preview
DeveloperAlly Feb 16, 2026
872ab7c
Merge docs-plan/02-consolidate-duplicates into docs-v2-preview
DeveloperAlly Feb 16, 2026
d74b5c2
Merge docs-plan/01-components-consolidate into docs-v2-preview
DeveloperAlly Feb 16, 2026
a58a1b9
feat(nav): add component library to Documentation Guide navigation
DeveloperAlly Feb 16, 2026
db96a40
Update docs.json navigation for Livepeer Studio reorganization
DeveloperAlly Feb 16, 2026
a13d961
Add RFP goals assessment report
DeveloperAlly Feb 16, 2026
a9807a2
Add audit report for v2 missing and incomplete pages
DeveloperAlly Feb 16, 2026
5475b6b
Add audit report for v2 missing and incomplete pages
DeveloperAlly Feb 16, 2026
d0926ab
Add Task 13: Audit repeated content report
DeveloperAlly Feb 16, 2026
0fef02b
Update Task 13 report: Focus on actual content duplication
DeveloperAlly Feb 16, 2026
b02860f
Complete documentation guide in Resources section
DeveloperAlly Feb 16, 2026
20771e9
Complete documentation guide in Resources section
DeveloperAlly Feb 16, 2026
ae8f160
Merge branch 'docs-plan/13-audit-repeated-content' into docs-v2-preview
DeveloperAlly Feb 16, 2026
4b21aff
Add documentation guide resources report
DeveloperAlly Feb 16, 2026
d21a1e1
Merge branch 'docs-plan/15-audit-v2-missing-incomplete' into docs-v2-…
DeveloperAlly Feb 16, 2026
217a4b2
Fix MDX errors: remove invalid imports and fix syntax
DeveloperAlly Feb 16, 2026
eef6a35
Export RefCardContainer from Portals.jsx
DeveloperAlly Feb 16, 2026
d355cd1
Merge docs-plan/01-components-consolidate: resolve conflicts by keepi…
DeveloperAlly Feb 16, 2026
8d70005
Merge branch 'docs-plan/02-components-audit-unused' into docs-v2-preview
DeveloperAlly Feb 16, 2026
147a10d
Merge branch 'docs-plan/05-homogenise-styling' into docs-v2-preview
DeveloperAlly Feb 16, 2026
1fa3343
Merge docs-plan/14-audit-v1-to-v2-coverage: resolve conflict
DeveloperAlly Feb 16, 2026
a2debb2
Merge pull request #5 from DeveloperAlly/docs-plan/02-components-audi…
DeveloperAlly Feb 16, 2026
ff1a15f
Merge pull request #6 from DeveloperAlly/docs-plan/05-homogenise-styling
DeveloperAlly Feb 16, 2026
49264e6
Merge pull request #8 from DeveloperAlly/docs-plan/14-audit-v1-to-v2-…
DeveloperAlly Feb 16, 2026
4d655c0
test valid file
DeveloperAlly Feb 16, 2026
736272d
Merge branch 'docs-v2-preview' of https://github.com/DeveloperAlly/li…
DeveloperAlly Feb 16, 2026
7711003
Update hook to skip style-guide.mdx
DeveloperAlly Feb 16, 2026
fc5f377
Save work in progress: component library updates, plan docs, and test…
DeveloperAlly Feb 16, 2026
b12762c
feat: add v2 pages browser test workflow and scripts
DeveloperAlly Feb 16, 2026
488e5e2
Backup: Component library with duplicate headers removed
DeveloperAlly Feb 16, 2026
4e46b8f
Merge branch 'docs-v2-preview' into docs-v2-preview
DeveloperAlly Feb 16, 2026
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
45 changes: 45 additions & 0 deletions .cursorrules
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# Cursor Rules for Livepeer Documentation

## MANDATORY: Read Style Guide Before Making Changes

**BEFORE making any code, styling, or component changes, you MUST read:**
- `v2/pages/07_resources/documentation-guide/style-guide.mdx` - Production-grade styling guidelines
- `v2/pages/07_resources/documentation-guide/component-library.mdx` - Component reference

## Critical Styling Rules

1. **USE CSS Custom Properties ONLY** - Never use ThemeData or hardcode colors
- ✅ Use: `var(--accent)`, `var(--text)`, `var(--card-background)`
- ❌ Never use: `ThemeData.light.accent` or hardcoded hex colors

2. **Mintlify Gotchas** - Read the style guide for all Mintlify limitations:
- Import paths must be absolute from root
- Cannot import into component files
- JSX files cannot import other JSX files
- React hooks are global (no imports needed)

3. **Component Usage** - Always check component library before creating new components

## Repository Structure

- `v2/pages/` - Current documentation pages (MDX)
- `snippets/components/` - Custom React/JSX components
- `snippets/data/` - Reusable data files
- `style.css` - Global CSS Custom Properties for theming
- `docs.json` - Mintlify navigation configuration

## Before Making Changes

1. Read the style guide: `v2/pages/07_resources/documentation-guide/style-guide.mdx`
2. Check component library: `v2/pages/07_resources/documentation-guide/component-library.mdx`
3. Review Mintlify gotchas in style guide
4. Use existing components when possible
5. Follow CSS Custom Properties for all styling

## Documentation Standards

- Use CSS Custom Properties for all theme-aware colors
- Follow Mintlify import patterns (absolute paths from root)
- Test in both light and dark modes
- No suggestions or recommendations in production docs
- Keep production docs factual only
95 changes: 95 additions & 0 deletions .githooks/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,95 @@
# Git Hooks - Quick Reference

This directory contains git hooks for enforcing repository standards.

**📖 Full Documentation:** See [docs/CONTRIBUTING/GIT-HOOKS.md](../../docs/CONTRIBUTING/GIT-HOOKS.md)

## Quick Start

```bash
# Install hooks
./.githooks/install.sh
```

## Pre-commit Hook

The pre-commit hook enforces style guide compliance and runs verification scripts:

### Style Guide Checks

- ❌ **ThemeData usage** - Blocks deprecated ThemeData imports
- ❌ **Hardcoded colors** - Warns about hardcoded hex colors that should use CSS variables
- ⚠️ **Relative imports** - Warns about relative imports (should use absolute paths)
- ⚠️ **@mintlify/components imports** - Warns about unnecessary imports (components are global)
- ⚠️ **React hook imports** - Warns about unnecessary React imports (hooks are global)

### Verification Scripts

The hook also runs `.githooks/verify.sh` which checks:

- ✅ **MDX syntax** - Validates frontmatter and basic MDX structure
- ✅ **JSON syntax** - Validates JSON files are parseable
- ✅ **Shell script syntax** - Validates shell scripts with `bash -n`
- ✅ **JavaScript syntax** - Validates JS files with `node --check`
- ✅ **Mintlify config** - Validates docs.json/mint.json syntax
- ✅ **Import paths** - Ensures snippets imports use absolute paths
- ✅ **Browser validation** - Tests MDX files in headless browser (requires `mint dev` running)

## Installation

To install the pre-commit hook:

```bash
cp .githooks/pre-commit .git/hooks/pre-commit
chmod +x .git/hooks/pre-commit
```

Or use the install script:

```bash
./.githooks/install.sh
```

## Manual Installation

If the install script doesn't work:

```bash
# Copy the hook
cp .githooks/pre-commit .git/hooks/pre-commit

# Make it executable
chmod +x .git/hooks/pre-commit

# Verify it's installed
ls -la .git/hooks/pre-commit
```

## Testing

Test the hook by staging a file with a violation:

```bash
# Create a test file with ThemeData (should fail)
echo 'import { ThemeData } from "/snippets/styles/themeStyles.jsx";' > test-violation.jsx
git add test-violation.jsx
git commit -m "test" # Should be blocked

# Clean up
rm test-violation.jsx
git reset HEAD test-violation.jsx
```

## Bypassing (Not Recommended)

If you absolutely must bypass the hook (not recommended):

```bash
git commit --no-verify -m "message"
```

**Warning:** Only bypass if you have a legitimate reason and understand the style guide violations.

## Style Guide Reference

See: `v2/pages/07_resources/documentation-guide/style-guide.mdx`
32 changes: 32 additions & 0 deletions .githooks/install.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
#!/bin/bash
# Install git hooks

HOOKS_DIR=".git/hooks"
SOURCE_DIR=".githooks"

if [ ! -d "$HOOKS_DIR" ]; then
echo "Error: .git/hooks directory not found. Are you in the repository root?"
exit 1
fi

if [ ! -d "$SOURCE_DIR" ]; then
echo "Error: .githooks directory not found. Are you in the repository root?"
exit 1
fi

echo "Installing git hooks..."

# Install pre-commit hook
if [ -f "$SOURCE_DIR/pre-commit" ]; then
cp "$SOURCE_DIR/pre-commit" "$HOOKS_DIR/pre-commit"
chmod +x "$HOOKS_DIR/pre-commit"
echo "✓ Installed pre-commit hook"
else
echo "✗ pre-commit hook not found in $SOURCE_DIR"
fi

echo ""
echo "Git hooks installed successfully!"
echo ""
echo "The pre-commit hook will now check for style guide violations."
echo "See .githooks/README.md for details."
172 changes: 172 additions & 0 deletions .githooks/pre-commit
Original file line number Diff line number Diff line change
@@ -0,0 +1,172 @@
#!/bin/bash
# Pre-commit hook to enforce style guide compliance
# Checks for common violations before allowing commits
#
# To install this hook, run:
# cp .githooks/pre-commit .git/hooks/pre-commit
# chmod +x .git/hooks/pre-commit

STYLE_GUIDE_PATH="v2/pages/07_resources/documentation-guide/style-guide.mdx"
VIOLATIONS=0
WARNINGS=()

# Colors for output
RED='\033[0;31m'
YELLOW='\033[1;33m'
GREEN='\033[0;32m'
NC='\033[0m' # No Color

echo -e "${YELLOW}🔍 Checking style guide compliance...${NC}"

# Get list of staged files
STAGED_FILES=$(git diff --cached --name-only --diff-filter=ACM | grep -E '\.(jsx|tsx|js|mdx)$')

if [ -z "$STAGED_FILES" ]; then
echo -e "${GREEN}✓ No JSX/TSX/MDX files staged, skipping style checks${NC}"
exit 0
fi

# Check 1: ThemeData import/usage (DEPRECATED)
echo "Checking for ThemeData usage (deprecated)..."
for file in $STAGED_FILES; do
if [ -f "$file" ]; then
# Skip if it's the style guide itself (it documents ThemeData as deprecated)
if [[ "$file" == *"style-guide.mdx" ]]; then
continue
fi
if grep -q "ThemeData\|themeStyles\.jsx" "$file" 2>/dev/null; then
WARNINGS+=("❌ $file: Uses deprecated ThemeData - use CSS Custom Properties instead")
VIOLATIONS=$((VIOLATIONS + 1))
fi
fi
done

# Check 2: Hardcoded hex colors that should use CSS variables
echo "Checking for hardcoded colors..."
for file in $STAGED_FILES; do
if [ -f "$file" ]; then
# Skip style guide (it documents colors in tables)
if [[ "$file" == *"style-guide.mdx" ]]; then
continue
fi
# Check for common Livepeer colors hardcoded (should use CSS vars)
# Exclude markdown tables and code examples
if grep -E "(#3CB540|#2b9a66|#18794E|#181C18|#E0E4E0|#717571|#A0A4A0)" "$file" 2>/dev/null | grep -v "var(--" | grep -v "CSS Custom Properties" | grep -v "style-guide" | grep -v "Color System" | grep -v "Light Mode\|Dark Mode" | grep -v "^\|" | grep -v "^```" > /dev/null; then
WARNINGS+=("⚠️ $file: Contains hardcoded theme colors - use CSS Custom Properties (var(--accent), etc.)")
VIOLATIONS=$((VIOLATIONS + 1))
fi
fi
done

# Check 3: Relative imports (should be absolute from root)
echo "Checking for relative imports..."
for file in $STAGED_FILES; do
if [ -f "$file" ]; then
if grep -E "from ['\"].*\.\./.*['\"]" "$file" 2>/dev/null | grep -v "node_modules" | grep -v "\.\./\.\./\.\." | grep -v "examples/" > /dev/null; then
WARNINGS+=("⚠️ $file: Uses relative imports - use absolute paths from root (/snippets/...)")
VIOLATIONS=$((VIOLATIONS + 1))
fi
fi
done

# Check 4: Import from @mintlify/components (should not import, they're global)
echo "Checking for @mintlify/components imports..."
for file in $STAGED_FILES; do
if [ -f "$file" ]; then
# Skip style guide (it documents this as a "don't do this" example)
if [[ "$file" == *"style-guide.mdx" ]]; then
continue
fi
if grep -q "from ['\"]@mintlify/components['\"]" "$file" 2>/dev/null; then
WARNINGS+=("⚠️ $file: Imports from @mintlify/components - these are global, no import needed")
VIOLATIONS=$((VIOLATIONS + 1))
fi
fi
done

# Check 5: React imports (hooks are global in Mintlify)
echo "Checking for unnecessary React imports..."
for file in $STAGED_FILES; do
if [ -f "$file" ]; then
# Skip style guide (it documents this as a "don't do this" example)
if [[ "$file" == *"style-guide.mdx" ]]; then
continue
fi
if grep -E "import.*\{.*useState|useEffect|useMemo|useCallback.*\}.*from ['\"]react['\"]" "$file" 2>/dev/null; then
WARNINGS+=("⚠️ $file: Imports React hooks - hooks are global in Mintlify, no import needed")
VIOLATIONS=$((VIOLATIONS + 1))
fi
fi
done

# Run verification scripts
echo ""
echo -e "${YELLOW}━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━${NC}"
echo -e "${YELLOW}Running verification scripts...${NC}"
if [ -f ".githooks/verify.sh" ]; then
if bash .githooks/verify.sh; then
echo -e "${GREEN}✓ Verification scripts passed${NC}"
else
VERIFY_EXIT=$?
if [ $VERIFY_EXIT -ne 0 ]; then
VIOLATIONS=$((VIOLATIONS + 1))
WARNINGS+=("❌ Verification scripts failed - see output above")
fi
fi
else
echo -e "${YELLOW}⚠️ Verification script not found, skipping...${NC}"
fi
echo -e "${YELLOW}━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━${NC}"

# Run test suite (fast mode for pre-commit)
echo ""
echo -e "${YELLOW}━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━${NC}"
echo -e "${YELLOW}Running test suite (staged files only)...${NC}"
if [ -f "tests/run-all.js" ] && command -v node &>/dev/null; then
if node tests/run-all.js --staged --skip-browser 2>&1; then
echo -e "${GREEN}✓ Test suite passed${NC}"
else
TEST_EXIT=$?
if [ $TEST_EXIT -ne 0 ]; then
VIOLATIONS=$((VIOLATIONS + 1))
WARNINGS+=("❌ Test suite failed - see output above")
fi
fi
else
echo -e "${YELLOW}⚠️ Test suite not available, skipping...${NC}"
fi
echo -e "${YELLOW}━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━${NC}"

# Report results
echo ""
if [ $VIOLATIONS -eq 0 ]; then
echo -e "${GREEN}✓ Style guide compliance check passed!${NC}"
exit 0
else
echo -e "${RED}╔═══════════════════════════════════════════════════════════════╗${NC}"
echo -e "${RED}║ STYLE GUIDE VIOLATIONS DETECTED - COMMIT BLOCKED ║${NC}"
echo -e "${RED}╚═══════════════════════════════════════════════════════════════╝${NC}"
echo ""
echo -e "${YELLOW}Found $VIOLATIONS violation(s):${NC}"
echo ""
for warning in "${WARNINGS[@]}"; do
echo -e "${RED}$warning${NC}"
done
echo ""
echo -e "${YELLOW}━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━${NC}"
echo -e "${YELLOW}📖 MANDATORY: Read the Style Guide before committing:${NC}"
echo -e "${YELLOW} $STYLE_GUIDE_PATH${NC}"
echo ""
echo -e "${YELLOW}Key Rules:${NC}"
echo -e " • Use CSS Custom Properties: var(--accent), var(--text), etc."
echo -e " • NEVER use ThemeData from themeStyles.jsx (deprecated)"
echo -e " • NEVER hardcode hex colors that should adapt to theme"
echo -e " • Use absolute imports: /snippets/components/..."
echo -e " • Mintlify components are global (no imports needed)"
echo -e " • React hooks are global (no imports needed)"
echo ""
echo -e "${YELLOW}━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━${NC}"
echo -e "${RED}Commit blocked. Fix violations and try again.${NC}"
echo ""
exit 1
fi
Loading
Loading