Skip to content

Add getting started documentation #56

@WilliamBerryiii

Description

@WilliamBerryiii

Issue Description

This documentation update adds a comprehensive getting started guide to help users configure their projects to use HVE Core's GitHub Copilot customizations.

Changes:

  • New Documentation: docs/getting-started.md - Step-by-step setup guide covering:

    • Prerequisites and directory structure
    • VS Code settings configuration for Copilot customizations
    • Development container setup with mount instructions
    • Verification steps and troubleshooting
  • README Update: Added "Setup" section linking to the new getting started guide

Impact: Users now have clear documentation on how to integrate HVE Core customizations into their projects using either VS Code workspace settings or dev containers.

Additional Context

The guide follows the repository's markdown standards with proper frontmatter and footer formatting. It includes both bash and PowerShell examples for broader platform support.

Files modified:

  • docs/getting-started.md (new, 107 lines)
  • README.md (modified, added Setup section)

Tracking: .copilot-tracking/plans/20251115-getting-started-guide-plan.instructions.md

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions