Skip to content

feat: add multiple onboarding template variants#15

Closed
mgiovani wants to merge 1 commit intomainfrom
feature/onboarding-templates
Closed

feat: add multiple onboarding template variants#15
mgiovani wants to merge 1 commit intomainfrom
feature/onboarding-templates

Conversation

@mgiovani
Copy link
Copy Markdown
Owner

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)

  • File: onboarding_developer.md
  • Best For: Technical onboarding for software engineers
  • Length: ~200 lines
  • Sections: Setup, Development Workflow, Project Structure, Testing, Troubleshooting, Resources

2. Contributor Template

  • File: onboarding_contributor.md
  • Best For: Open source projects welcoming external contributions
  • Length: ~240 lines
  • Sections: Contribution Types, Workflow, PR Guidelines, Community Guidelines, Recognition, Support

3. User Template

  • File: onboarding_user.md
  • Best For: Product documentation for end users
  • Length: ~180 lines
  • Sections: Installation, Getting Started, Features, Configuration, Troubleshooting, Support

Configuration

Templates can be configured in .cursor-init.yaml:

templates:
  onboarding: "developer"  # Options: developer, contributor, user

Changes Made

  • Added 3 new onboarding template variants with comprehensive content
  • Removed outdated templates (general, python, frontend)
  • Updated configuration system to support onboarding template selection
  • Added documentation for onboarding template customization
  • Comprehensive placeholder system for template customization

Template Features

Common Placeholders

  • {{PROJECT_NAME}} - Project name
  • {{DATE}} - Current date
  • {{AUTHOR}} - Document author

Onboarding-Specific Placeholders

  • {{INSTALL_COMMANDS}} - Installation commands
  • {{TEST_COMMANDS}} - Testing commands
  • {{COMMUNICATION_CHANNEL}} - Team communication channel

Integration

The /init-docs command will automatically use the configured onboarding template variant when creating initial documentation.

Testing

  • ✅ Templates follow consistent placeholder conventions
  • ✅ All templates are well-structured with clear sections
  • ✅ Configuration system properly supports template selection
  • ✅ Documentation updated with usage examples

Breaking Changes

⚠️ Minor Breaking Change: Old template files (onboarding_general.md, onboarding_python.md, onboarding_frontend.md) have been removed and replaced with the new variant system.

Migration: Update your .cursor-init.yaml to use the new template names:

  • generaldeveloper
  • pythondeveloper
  • frontenddeveloper

This is the first PR in a series to add template variants for all document types. Subsequent PRs will add:

  • RFC template variants
  • Data model template variants
  • Rules updates for complete template configuration support

…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
Copilot AI review requested due to automatic review settings June 15, 2025 21:23
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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)

@mgiovani
Copy link
Copy Markdown
Owner Author

🔄 Consolidated into PR #17

This PR has been consolidated into the comprehensive template improvements PR #17 which includes:

  • ✅ Onboarding templates + data model templates (this PR)
  • ✅ RFC templates
  • ✅ Enhanced architecture templates
  • ✅ All slash commands respecting template configuration

Please review and merge PR #17 instead of this individual PR.

Link to comprehensive PR: #17

@mgiovani mgiovani closed this Jun 15, 2025
@mgiovani mgiovani deleted the feature/onboarding-templates branch June 15, 2025 21:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants