Skip to content

Commit 92a97b6

Browse files
docs(admin): update content management workflow documentation
1 parent 6b089e2 commit 92a97b6

File tree

1 file changed

+33
-8
lines changed

1 file changed

+33
-8
lines changed

apps/web/src/routes/admin/README.md

Lines changed: 33 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -34,16 +34,30 @@ Import blog posts from published Google Docs with automatic HTML-to-Markdown con
3434
4. Fill in metadata (title, author, description, cover image)
3535
5. Select destination folder and save
3636

37-
### Content Management (`/admin/content`)
37+
### Content Management (`/admin/collections`)
3838

39-
Browse and view MDX content files across all content folders:
39+
Full-featured blog editor with the following capabilities:
4040

41-
- Articles
42-
- Changelog
43-
- Documentation
44-
- Handbook
45-
- Legal
46-
- Templates
41+
- Create, edit, and manage blog articles
42+
- Rich text editor with Google Docs import
43+
- Metadata panel (title, author, date, description, category, cover image)
44+
- Preview mode with side-by-side editing
45+
- Git history tracking
46+
- Draft management with branch-based workflow
47+
48+
#### Editorial Workflow
49+
50+
When editing a published article:
51+
52+
1. **Save** - Creates/updates a PR branch with `ready_for_review: false`
53+
2. **Submit for Review** - Updates the article with `ready_for_review: true` and adds a reviewer
54+
3. GitHub Actions detects the status and sends appropriate Slack notifications:
55+
- Regular edits: "✏️ {user} made changes to {title}"
56+
- Submitted for review: "👀 Article submitted for review" (tags reviewer)
57+
58+
The `ready_for_review` field in frontmatter tracks the editorial state:
59+
- `false` (default): Article is being edited
60+
- `true`: Article is ready for content review
4761

4862
## API Endpoints
4963

@@ -65,6 +79,17 @@ All API endpoints require admin authentication.
6579
### Content APIs
6680

6781
- `GET /api/admin/content/list` - List content files in a folder
82+
- `GET /api/admin/content/list-drafts` - List draft articles from branches
83+
- `GET /api/admin/content/pending-pr` - Check if article has a pending edit PR
84+
- `GET /api/admin/content/get-branch-file` - Get file content from a branch
85+
- `GET /api/admin/content/history` - Get git commit history for a file
86+
- `POST /api/admin/content/save` - Save content (creates PR for published articles)
87+
- `POST /api/admin/content/create` - Create new content file
88+
- `POST /api/admin/content/publish` - Publish/unpublish an article
89+
- `POST /api/admin/content/submit-for-review` - Submit article for editorial review
90+
- `POST /api/admin/content/rename` - Rename a content file
91+
- `POST /api/admin/content/duplicate` - Duplicate a content file
92+
- `POST /api/admin/content/delete` - Delete a content file
6893

6994
## Environment Variables
7095

0 commit comments

Comments
 (0)