← Back to Home

Documentation

All documentation is available on GitHub. Click "View" to read or "Raw" to download.

Getting Started

README

Overview of the AI coding standards system, structure, and how to use it.

View Raw

General Instructions

Core principles and guidelines that apply to all languages and frameworks.

View Raw

Editor Setup

LazyVim & VSCode

Complete editor configuration for LazyVim (preferred) and VSCode, including keybindings, plugins, and language-specific setup.

View Raw

Language-Specific Patterns

Go

Accept interfaces, return concrete types. Functional options. Table-driven tests. Context-aware functions.

View Raw

Python

Mandatory type hints (mypy strict). Use uv for package management. Pydantic for validation. Async/await patterns.

View Raw

TypeScript/Vue

Composition API with <script setup>. Strict TypeScript mode. Explicit type annotations. Composables.

View Raw

PowerShell

Multi-subscription operations by default. Prefer Azure Resource Graph over loops. Session validation. Graph API patterns.

View Raw

Bash

Shellcheck validation. Proper error handling with set -euo pipefail. Robust scripting patterns.

View Raw

SQL

Query optimization patterns. Parameterized queries. Index strategies. Transaction handling.

View Raw

Format & Configuration Standards

YAML

Schema validation. Anchors and aliases. Multi-document files. Kubernetes and CI/CD patterns.

View Raw

JSON

JSON Schema validation. Configuration patterns. API response structures. Package manifests.

View Raw

Markdown

Documentation standards. README templates. Consistent formatting. Code block conventions.

View Raw

RPM

Spec file patterns. Macro usage. Dependency management. Build configuration.

View Raw

Systemd

Unit file patterns. Service, timer, and socket configuration. Security hardening.

View Raw

gRPC

Protocol Buffer message design. Service definitions. Backward compatibility. Use buf for code generation.

View Raw

Makefile

Self-documenting help targets. Portable patterns for Linux, macOS, WSL. .PHONY targets. Language-specific templates.

View Raw

AI Prompts

Prompts Overview

Guide to using prompt templates with AI coding assistants.

View Raw

Code Review

Templates for reviewing code against standards.

View Raw

Refactoring

Templates for refactoring code to meet standards.

View Raw

New Feature

Templates for implementing new features.

View Raw

Debugging

Templates for debugging issues with AI assistance.

View Raw

Configuration Files

.aiignore

Files and directories to exclude from AI context.

View Raw