Move markdown and test files to directory #3
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Move all template files to root for Netlify deployment - Organize documentation into /docs/ with subdirectories: - /docs/ contains course documentation - /docs/repository/ contains template repository documentation - /docs/testing/ contains all test files and reports - Replace root README with course website README - Remove duplicate PROJECT_OVERVIEW.md (kept in docs/)
- Add "What Is This?" section explaining the template's purpose - Provide detailed Getting Started guide with two paths (automated vs manual) - Expand repository structure with emojis and clear descriptions - Add Common Customization Tasks with step-by-step instructions: - Creating first lecture - Changing colors and branding - Updating course information - Enhance Deployment Options with detailed steps for GitHub Pages and Netlify - Add comparison table for different hosting platforms - Improve Database Setup with complete step-by-step instructions - Add comprehensive FAQ section covering: - General questions - Technical questions - Customization questions - Add Troubleshooting section for common issues - Expand documentation references - Add Contributing guidelines - Update all documentation links to new paths (docs/testing/, docs/repository/) This makes the README significantly more instructive and beginner-friendly.
bobbyreed
deleted the
claude/cleanup-template-repo-019uK1ALbXYHtUfaqFkTs7Ux
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.