Comprehensive workflow for synchronizing website documentation with project changes
Automated workflow for keeping the fwdslsh website synchronized with project repositories.
Use this skill when:
Trigger phrases:
This skill automates the discovery and analysis phases of website synchronization, then guides through manual content updates following a structured workflow.
1. Full Sync (4-8 hours)
2. Targeted Sync (1-3 hours)
Before running this skill:
Step 1.1: Check Current Status
Run the automated discovery script:
cd /home/founder3/code/github/fwdslsh/website
./scripts/full-sync.sh
Expected Output:
website-sync/Step 1.2: Review Discovery Reports
Read the generated reports:
# Overall summary
cat website-sync/sync-summary-*.md
# Project-specific info
ls -la website-sync/*-info.md
# Change details
cat website-sync/changes-detected-*.md
Decision Point: Based on reports, determine:
Step 2.1: Identify Affected Pages
For each changed project, identify website pages to update:
Project → Page Mapping:
disclose → src/disclose/index.html
src/disclose/getting-started.html
src/disclose/docs.html
src/disclose/examples.html
src/index.html (tool card)
src/ecosystem/index.html
gather → src/gather/index.html
src/gather/getting-started.html
src/gather/docs.html
src/gather/examples.html
src/index.html (tool card)
src/ecosystem/index.html
dispatch → src/dispatch/index.html
src/dispatch/getting-started.html
src/dispatch/docs.html
src/dispatch/examples.html
src/index.html (tool card)
src/ecosystem/index.html
# Similar mappings for other projects
Step 2.2: Create Update Checklist
Generate a prioritized checklist:
# Website Update Checklist
Date: [YYYY-MM-DD]
Projects: [list]
## Critical (Do First)
- [ ] [Project]: Update version number (5min)
- [ ] [Project]: Fix incorrect commands (10min)
## High Priority
- [ ] [Project]: Add new feature section (30min)
- [ ] [Project]: Update command reference (45min)
## Medium Priority
- [ ] [Project]: Refresh examples (1hr)
- [ ] [Project]: Update integration docs (1hr)
## Low Priority
- [ ] [Project]: Polish descriptions (30min)
Total Time: [X hours]
Step 2.3: Prepare Content Outlines
For each page to update, create outline:
# Update Outline: [project]/[page]
## Current State
[Brief description]
## Required Changes
1. Section: [Name]
- Current: [text]
- New: [text]
- Source: [project README/CLAUDE.md]
2. Section: [Name]
- Action: [Add|Update|Remove]
- Content: [outline]
## Examples to Update
- Old: `old command`
- New: `new command`
Step 3.1: Create Feature Branch
git checkout -b website-sync-$(date +%Y%m%d)
Step 3.2: Update Pages Systematically
For each item in checklist:
cat src/[project]/[page].html
cat ../core/packages/[project]/README.md
cat ../core/packages/[project]/CLAUDE.md
Make changes: Edit files following content guidelines (see docs/content-guidelines.md)
Verify changes:
git diff src/[project]/[page].html
npm run build
git add src/[project]/[page].html
git commit -m "docs: update [project]/[page] - [description]"
Common Update Patterns:
Pattern A: Version Number
sed -i 's/v0\.1\.0/v0\.2\.0/g' src/[project]/index.html
Pattern B: Feature List
<!-- Add new feature -->
<li>Feature C - New in v0.2.0</li>
Pattern C: Command Examples
<pre class="code-snippet">$ new-command --flag value
$ updated-command --new-option</pre>
Pattern D: Tool Card (Home Page)
<div class="tool-card">
<div class="tool-header">
<div class="tool-icon">[letter]</div>
<div>
<h3>[tool]</h3>
<div class="subtitle">[updated subtitle]</div>
</div>
</div>
<p>[updated description]</p>
<pre class="code-snippet">$ [updated commands]</pre>
<p><strong>Why we built it:</strong> [updated reason]</p>
<div class="tool-links">
<a href="/[tool]">Documentation →</a>
<a href="[github-url]">GitHub →</a>
</div>
</div>
Step 4.1: Build Verification
npm run build
Expected: No errors, clean build
Step 4.2: Version Check
./scripts/check-version-sync.sh
Expected: All versions match
Step 4.3: Link Validation
./scripts/validate-links.sh
Expected: No broken links
Step 4.4: Visual Review
npm run dev
Then manually check:
Step 5.1: Final Commit
git log --oneline -10
git push origin website-sync-$(date +%Y%m%d)
Step 5.2: Create Pull Request (if using)
Title: docs: website sync - [date]
Body:
## Summary
Synchronized website with latest project changes.
## Projects Updated
- **[Project A]**: v0.1.0 → v0.2.0
- **[Project B]**: New features added
## Changes
- [X] Project pages updated
- [X] Home page refreshed
- [X] Versions synchronized
## Testing
- [x] Build successful
- [x] Links validated
- [x] Visual review complete
Step 5.3: Deploy
Follow project-specific deployment process.
Step 5.4: Record Sync
echo "$(date +%Y-%m-%d)" > website-sync/last-sync.log
When updating content, reference in this order:
Tone: Technical but accessible, focused on problems solved
Code Examples:
$ for shell promptsFormatting:
Key Sections:
Q: Changes detected but not significant? A: Update only version numbers and minor text, skip full content refresh.
Q: Major breaking changes? A: Add prominent notice, update all examples, document migration path.
Q: New features added? A: Create new section, add to feature list, provide examples.
Q: Examples need updating? A: Test commands first, verify output, then update.
Q: Unsure about technical accuracy? A: Flag for project maintainer review, don't guess.
After skill execution:
Issue: Build fails after updates
rm -rf .svelte-kit/ node_modules/
npm install
npm run build
Issue: Version mismatch persists Check all locations:
Issue: Links broken after restructuring
./scripts/validate-links.sh
# Fix hrefs in source files
Issue: Git conflicts
git status
git diff
# Resolve conflicts manually
Always Modified:
website-sync/last-sync.logwebsite-sync/*-info.mdwebsite-sync/sync-summary-*.mdPotentially Modified:
src/[project]/index.htmlsrc/[project]/getting-started.htmlsrc/[project]/docs.htmlsrc/[project]/examples.htmlsrc/index.html (home page tool cards)src/ecosystem/index.htmlsrc/_includes/base/nav.htmlsrc/_includes/base/footer.htmlThis skill produces:
Discovery Reports:
Updated Website Content:
Git History:
| Task | Estimated Time |
|---|---|
| Discovery (automated) | 15-30 min |
| Analysis & Planning | 30-60 min |
| Implementation (1 project) | 30-90 min |
| Implementation (all projects) | 2-5 hours |
| Verification | 30-60 min |
| Deployment | 30 min |
| Total (targeted) | 1-3 hours |
| Total (full sync) | 4-8 hours |
After each sync:
Version: 1.0.0 Last Updated: 2026-01-13 Maintained By: fwdslsh team Review Frequency: After each major sync
# Check status
./scripts/full-sync.sh
# Verify versions
./scripts/check-version-sync.sh
# Validate links
./scripts/validate-links.sh
# Create branch
git checkout -b website-sync-$(date +%Y%m%d)
# Build test
npm run build
# Dev server
npm run dev
# Deploy
git push origin website-sync-$(date +%Y%m%d)
# Record sync
echo "$(date +%Y-%m-%d)" > website-sync/last-sync.log
Ready to execute?
./scripts/full-sync.sh