Project Metadata

Overview

When to Use

• Creating a new project and need to initialize its structure
• Generating or updating README documentation for golang projects
• Setting up a social profile workspace

Supported Project Types

default

references/default.readme.md

golang

rules/go-structure.md

references/golang.readme.md

profile

rules/profile-structure.md

references/profile.readme.md

default

Project Initialization

Golang Projects

rules/go-structure.md

<project-name>/
├── cmd/        # CLI entry points (spf13/cobra)
├── config/     # Configuration and client initialization
├── model/      # Database CRUD operations
├── svc/        # Single domain business logic
├── handler/    # E2E feature orchestration
└── utils/      # Common helper functions

Social Profile Projects

rules/profile-structure.md

<project-name>/
├── archetype/   # Prototype models for the profile
├── background/  # Profile information and details
├── post/        # Generated posts (YYYYMMDD-<story> naming)
└── assets/      # Non-defined files

Metadata Generation

Default README (Any Project Type)

references/default.readme.md

1. Identifying Project Type - Detects language and framework from files
2. Traversing Domain Folders - Analyzes top-level folders (excluding infrastructure)
3. Analyzing Configuration - Extracts info from package files and configs
4. Finding Entry Points - Discovers how to run, build, and test
5. Understanding Purpose - Infers project goals from structure and docs
6. Generating README - Creates comprehensive documentation

references/default.readme.md

Golang README

references/golang.readme.md

1. Folder Structure - Documents key directories and their purposes
2. Handler List - HTTP/RPC endpoints with methods and descriptions
3. External Services - RPC, Database, Cache, MQ dependencies
4. Run/Test Instructions - Build, run, and testing commands

references/golang.readme.md

Social Profile Metadata

references/profile.readme.md

1. Profile Overview - Name, type, and description
2. Directory Structure - Standard profile directories
3. Background Information - Biography, personality, voice from

   background/

4. Archetype References - Prototype models from

   archetype/

5. Post List - All posts from

   post/

   with dates and content types

references/profile.readme.md

Resources

references/

default.readme.md

golang.readme.md

profile.readme.md