feat: add multiple onboarding template variants#15
Conversation
…ate for technical onboarding (~200 lines) - Add contributor template for open source projects (~240 lines) - Add user template for end-user documentation (~180 lines) - Remove old general/python/frontend templates - Update configuration to support onboarding template selection - Update documentation with onboarding template customization guide
There was a problem hiding this comment.
Pull Request Overview
This PR introduces multiple onboarding documentation template variants to support different audiences (developer, contributor, and user) while removing outdated templates. Key changes include new onboarding template files, updates to configuration examples in YAML, and comprehensive updates to the template customization guide.
Reviewed Changes
Copilot reviewed 10 out of 10 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| docs/development/template-customization.md | Updated guide with new onboarding template variant info and configuration instructions. |
| .cursor/templates/onboarding/onboarding_user.md | New user guide template for end-user documentation. |
| .cursor/templates/onboarding/onboarding_developer.md | New developer guide template with detailed setup instructions. |
| .cursor/templates/onboarding/onboarding_contributor.md | New contributor guide template with contribution workflow details. |
| .cursor/templates/onboarding/onboarding_python.md | Removed outdated Python onboarding template. |
| .cursor/templates/onboarding/onboarding_general.md | Removed outdated general onboarding template. |
| .cursor/templates/onboarding/onboarding_frontend.md | Removed outdated frontend onboarding template. |
| .cursor/templates/diagrams/*.md | New data model diagram templates added. |
| .cursor-init.example.yaml | Updated onboarding config from old to new variant names. |
Comments suppressed due to low confidence (2)
docs/development/template-customization.md:12
- Ensure that the configuration example and inline comments accurately reflect the new template naming and options. Also check for any lingering references to the removed template names.
onboarding: "developer" # Options: developer, contributor, user
docs/development/template-customization.md:17
- [nitpick] Verify that the updated heading structure and section ordering provide a clear, logical flow to readers given the significant reordering of content. Consider a brief introductory note outlining the changes.
### `developer` (Default)
|
🔄 Consolidated into PR #17 This PR has been consolidated into the comprehensive template improvements PR #17 which includes:
Please review and merge PR #17 instead of this individual PR. Link to comprehensive PR: #17 |
Summary
This PR adds multiple template variants for onboarding documentation, allowing teams to choose the onboarding style that best fits their project needs.
Templates Added
1. Developer Template (Default)
onboarding_developer.md2. Contributor Template
onboarding_contributor.md3. User Template
onboarding_user.mdConfiguration
Templates can be configured in
.cursor-init.yaml:Changes Made
Template Features
Common Placeholders
{{PROJECT_NAME}}- Project name{{DATE}}- Current date{{AUTHOR}}- Document authorOnboarding-Specific Placeholders
{{INSTALL_COMMANDS}}- Installation commands{{TEST_COMMANDS}}- Testing commands{{COMMUNICATION_CHANNEL}}- Team communication channelIntegration
The
/init-docscommand will automatically use the configured onboarding template variant when creating initial documentation.Testing
Breaking Changes
onboarding_general.md,onboarding_python.md,onboarding_frontend.md) have been removed and replaced with the new variant system.Migration: Update your
.cursor-init.yamlto use the new template names:general→developerpython→developerfrontend→developerThis is the first PR in a series to add template variants for all document types. Subsequent PRs will add: