ruvnet / ruvnet/ruflo

🚀 Plan Starlight Integration for OpenCode Course Template

Open
#503 1 comment 2 reactions 0 assignees View on GitHub
Dominant language
TypeScript
Stars
72.7k
Forks
8.6k
Avg merge
3d 3h
Merged PRs (30d)
85

Description

## Overview
Plan integration of the OpenCode course template with an existing Starlight documentation site for gated content delivery.

## Objective
Prepare OpenCode course content for manual migration to a Starlight implementation in a specific folder structure for gated/premium content access.

## Requirements Based on Testing Results

### Critical Issues to Address Before Migration
- [ ] **Fix Missing BaseDemo Class** - Create core base class that all demonstrations inherit from
- [ ] **Repair JavaScript Inheritance Chain** - Ensure all demo classes can instantiate properly
- [ ] **Add Missing Dependencies** - Create package.json with required npm packages
- [ ] **Test Interactive Functionality** - Verify demonstrations actually work before migration

### Starlight Compatibility Requirements
- [ ] **Content Structure Analysis** - Map current course structure to Starlight's content organization
- [ ] **Markdown Compatibility** - Ensure lesson files are compatible with Starlight's MDX processing
- [ ] **Asset Management** - Plan for CSS/JS/image assets in Starlight's public folder structure
- [ ] **Interactive Component Integration** - Adapt demos to work within Starlight's component system
- [ ] **Gated Content Strategy** - Design folder structure for premium/protected content

### Migration Planning Tasks
- [ ] **Folder Structure Design** - Define specific target folder in Starlight repository
- [ ] **File Mapping Documentation** - Create clear instructions for manual file copying
- [ ] **Dependency Integration** - Plan how to integrate course JavaScript/CSS with Starlight
- [ ] **Navigation Integration** - Plan how course content fits into Starlight sidebar
- [ ] **Component Adaptation** - Modify demonstrations to work as Starlight components

## Deliverables
1. **Migration Instructions Document** - Step-by-step copying and integration guide
2. **Starlight Compatibility Report** - Analysis of required modifications
3. **Folder Structure Specification** - Exact target paths and organization
4. **Fixed Core Functionality** - Working BaseDemo class and interactive components
5. **Testing Validation** - Proof that content works before migration

## Dependencies
- Starlight implementation details (folder structure, build process)
- Gated content access mechanism
- Current course template fixes (BaseDemo class, broken JavaScript)

## Notes
- **Manual Migration Only** - No automated integration, files will be copied manually
- **Gated Content Focus** - Content should be organized for premium/protected access
- **Starlight Native** - Content should work within Starlight's ecosystem
- **Testing First** - Fix broken functionality before planning migration

## Priority
**High** - Required before course content can be delivered through Starlight platform

## Labels
enhancement, documentation, starlight, course-content

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the current course template, its demonstration classes, lesson Markdown files, and existing assets, then inspect the Starlight implementation details and gated-content mechanism. Verify the BaseDemo and JavaScript inheritance issues, identify the package.json dependencies, and map the content, assets, navigation, and components to the target folder structure. Done means migration instructions, a compatibility report, a folder specification, working demonstrations, and testing validation.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, markdown, typescript
Domain
content, documentation, web-dev
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.