docs: add comprehensive project documentation#16
Open
marcuskbra wants to merge 3 commits intoAdventech:stagefrom
Open
docs: add comprehensive project documentation#16marcuskbra wants to merge 3 commits intoAdventech:stagefrom
marcuskbra wants to merge 3 commits intoAdventech:stagefrom
Conversation
Closes Adventech#8 Add project documentation to help new contributors get started: - README.md: Enhanced with features, tech stack, quick start guide, project structure, and environment configuration - CONTRIBUTING.md: Complete contribution guide with coding standards, Vue 3 Composition API patterns, git workflow, and PR process - CLAUDE.md: AI assistant guidance for codebase navigation - docs/ARCHITECTURE.md: Technical architecture covering multi-site system, block system, plugins, themes, and i18n - docs/API.md: API reference with endpoints, authentication flow, and error handling Also adds .serena/ to .gitignore for local development tooling.
Author
|
Hey @VitalikL! Hope you're doing well! Would you mind taking a moment to review this PR? Your feedback would be greatly appreciated! Thank you! |
Member
|
Hi @marcuskbra ! Thank you, appreciate your help. I can review over the weekend, but I see it's closed now |
Author
|
Hi @VitalikL. I apologize for the mistake; I accidentally deleted the branch, but it has now been reopened. |
VitalikL
reviewed
Jan 25, 2026
VitalikL
reviewed
Jan 25, 2026
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Summary
Closes #8
This PR adds comprehensive project documentation to help new contributors get started with the sabbath-school-web project.
Changes
New Files
CONTRIBUTING.md - Complete contribution guide with:
docs/ARCHITECTURE.md - Technical architecture documentation covering:
docs/API.md - API reference including:
CLAUDE.md - AI assistant guidance for codebase navigation
Modified Files
README.md - Enhanced with:
.gitignore - Added
.serena/for local development toolingTest Plan
yarn build