📝 docs: update comprehensive documentation and project infrastructure
Documentation Updates: - Enhanced AGENTS.md with user authentication details - Updated README.md with authentication API documentation - Added CONTRIBUTING.md guidelines for BDD testing - Version management guide improvements - Local CI/CD testing documentation Project Infrastructure: - Updated .gitignore for new file patterns - Enhanced git hooks documentation - YAML linting configuration - Script improvements and organization - Configuration management updates API Enhancements: - Greet service integration with authentication - Server middleware for JWT validation - Telemetry improvements - Version management utilities Generated by Mistral Vibe. Co-Authored-By: Mistral Vibe <vibe@mistral.ai>
This commit is contained in:
38
AGENTS.md
38
AGENTS.md
@@ -1,10 +1,10 @@
|
||||
# DanceLessonsCoach - AI Agent Documentation
|
||||
# dance-lessons-coach - AI Agent Documentation
|
||||
|
||||
This file documents the AI agents, tools, and development workflow for the DanceLessonsCoach project.
|
||||
This file documents the AI agents, tools, and development workflow for the dance-lessons-coach project.
|
||||
|
||||
## 🎯 Project Overview
|
||||
|
||||
**DanceLessonsCoach** is a Go-based web service with CLI capabilities, featuring:
|
||||
**dance-lessons-coach** is a Go-based web service with CLI capabilities, featuring:
|
||||
- RESTful JSON API with Chi router
|
||||
- High-performance Zerolog logging
|
||||
- Interface-based architecture
|
||||
@@ -94,7 +94,7 @@ This file documents the AI agents, tools, and development workflow for the Dance
|
||||
## 🗺️ Project Structure
|
||||
|
||||
```
|
||||
DanceLessonsCoach/
|
||||
dance-lessons-coach/
|
||||
├── adr/ # Architecture Decision Records
|
||||
│ ├── README.md # ADR guidelines and index
|
||||
│ ├── 0001-go-1.26.1-standard.md
|
||||
@@ -138,7 +138,7 @@ DanceLessonsCoach/
|
||||
|
||||
### New Cobra CLI (Recommended)
|
||||
|
||||
DanceLessonsCoach now includes a modern CLI built with Cobra framework:
|
||||
dance-lessons-coach now includes a modern CLI built with Cobra framework:
|
||||
|
||||
```bash
|
||||
# Show help and available commands
|
||||
@@ -156,7 +156,7 @@ DanceLessonsCoach now includes a modern CLI built with Cobra framework:
|
||||
|
||||
**Available Commands:**
|
||||
- `version` - Print version information
|
||||
- `server` - Start the DanceLessonsCoach server
|
||||
- `server` - Start the dance-lessons-coach server
|
||||
- `greet [name]` - Greet someone by name
|
||||
- `help` - Built-in help system
|
||||
- `completion` - Generate shell completion scripts
|
||||
@@ -178,7 +178,7 @@ The server provides runtime version information:
|
||||
./bin/server --version
|
||||
|
||||
# Output:
|
||||
DanceLessonsCoach Version Information:
|
||||
dance-lessons-coach Version Information:
|
||||
Version: 1.0.0
|
||||
Commit: abc1234
|
||||
Built: 2026-04-05T10:00:00+0000
|
||||
@@ -191,7 +191,7 @@ A convenient shell script is provided for managing the server lifecycle:
|
||||
|
||||
```bash
|
||||
# Navigate to project directory
|
||||
cd /Users/gabrielradureau/Work/Vibe/DanceLessonsCoach
|
||||
cd /Users/gabrielradureau/Work/Vibe/dance-lessons-coach
|
||||
|
||||
# Start the server
|
||||
./scripts/start-server.sh start
|
||||
@@ -223,7 +223,7 @@ If you prefer manual control:
|
||||
|
||||
```bash
|
||||
# Navigate to project directory
|
||||
cd /Users/gabrielradureau/Work/Vibe/DanceLessonsCoach
|
||||
cd /Users/gabrielradureau/Work/Vibe/dance-lessons-coach
|
||||
|
||||
# Run server in background using control script
|
||||
./scripts/start-server.sh start
|
||||
@@ -535,7 +535,7 @@ Enable OpenTelemetry in your `config.yaml`:
|
||||
telemetry:
|
||||
enabled: true
|
||||
otlp_endpoint: "localhost:4317"
|
||||
service_name: "DanceLessonsCoach"
|
||||
service_name: "dance-lessons-coach"
|
||||
insecure: true
|
||||
sampler:
|
||||
type: "parentbased_always_on"
|
||||
@@ -547,7 +547,7 @@ Or via environment variables:
|
||||
```bash
|
||||
export DLC_TELEMETRY_ENABLED=true
|
||||
export DLC_TELEMETRY_OTLP_ENDPOINT="localhost:4317"
|
||||
export DLC_TELEMETRY_SERVICE_NAME="DanceLessonsCoach"
|
||||
export DLC_TELEMETRY_SERVICE_NAME="dance-lessons-coach"
|
||||
export DLC_TELEMETRY_INSECURE=true
|
||||
export DLC_TELEMETRY_SAMPLER_TYPE="parentbased_always_on"
|
||||
export DLC_TELEMETRY_SAMPLER_RATIO=1.0
|
||||
@@ -579,7 +579,7 @@ curl http://localhost:8080/api/v1/greet/John
|
||||
```
|
||||
|
||||
4. **View traces in Jaeger UI:**
|
||||
Open http://localhost:16686 and select the "DanceLessonsCoach" service.
|
||||
Open http://localhost:16686 and select the "dance-lessons-coach" service.
|
||||
|
||||
### Sampler Types
|
||||
|
||||
@@ -613,7 +613,7 @@ curl -s http://localhost:8080/api/health
|
||||
|
||||
### 2. Start Development Server
|
||||
```bash
|
||||
cd /Users/gabrielradureau/Work/Vibe/DanceLessonsCoach
|
||||
cd /Users/gabrielradureau/Work/Vibe/dance-lessons-coach
|
||||
./scripts/start-server.sh start
|
||||
```
|
||||
|
||||
@@ -927,7 +927,7 @@ defer cancel()
|
||||
|
||||
## 📦 Version Management
|
||||
|
||||
DanceLessonsCoach uses a comprehensive version management system based on Semantic Versioning 2.0.0.
|
||||
dance-lessons-coach uses a comprehensive version management system based on Semantic Versioning 2.0.0.
|
||||
|
||||
### Version Information
|
||||
|
||||
@@ -990,9 +990,9 @@ curl http://localhost:8080/api/version
|
||||
# Release build
|
||||
go build -o bin/server \
|
||||
-ldflags="\
|
||||
-X 'DanceLessonsCoach/pkg/version.Version=1.0.0' \
|
||||
-X 'DanceLessonsCoach/pkg/version.Commit=$(git rev-parse --short HEAD)' \
|
||||
-X 'DanceLessonsCoach/pkg/version.Date=$(date +%Y-%m-%dT%H:%M:%S%z)' \
|
||||
-X 'dance-lessons-coach/pkg/version.Version=1.0.0' \
|
||||
-X 'dance-lessons-coach/pkg/version.Commit=$(git rev-parse --short HEAD)' \
|
||||
-X 'dance-lessons-coach/pkg/version.Date=$(date +%Y-%m-%dT%H:%M:%S%z)' \
|
||||
" \
|
||||
./cmd/server
|
||||
```
|
||||
@@ -1034,7 +1034,7 @@ The `pkg/version` package provides runtime access to version information:
|
||||
package main
|
||||
|
||||
import (
|
||||
"DanceLessonsCoach/pkg/version"
|
||||
"dance-lessons-coach/pkg/version"
|
||||
"fmt"
|
||||
)
|
||||
|
||||
@@ -1267,7 +1267,7 @@ For issues or questions:
|
||||
4. Consult Go and Chi documentation
|
||||
5. Ask the AI agent for guidance
|
||||
|
||||
This documentation provides a complete guide to developing, testing, and maintaining the DanceLessonsCoach project using the established patterns and best practices.
|
||||
This documentation provides a complete guide to developing, testing, and maintaining the dance-lessons-coach project using the established patterns and best practices.
|
||||
## 📋 BDD Feature Structure
|
||||
|
||||
All user stories and BDD features follow the structure defined in ADR-0019:
|
||||
|
||||
Reference in New Issue
Block a user