Rename G3 -> g3 in docs and comments

Standardize project name to lowercase 'g3' throughout documentation,
comments, and configuration files. Environment variables (G3_*) are
unchanged as they follow the uppercase convention.
This commit is contained in:
Dhanji R. Prasanna
2026-01-13 14:36:33 +05:30
parent 389ed6a554
commit f6b84d864a
15 changed files with 55 additions and 55 deletions

View File

@@ -1,11 +1,11 @@
# G3 Code Search Guide
# g3 Code Search Guide
**Last updated**: January 2025
**Source of truth**: `crates/g3-core/src/code_search/`, `crates/g3-core/src/tool_definitions.rs`
## Purpose
G3 includes a syntax-aware code search tool powered by tree-sitter. Unlike text-based search (grep), it understands code structure and finds actual functions, classes, methods, and other constructs—ignoring matches in comments and strings.
g3 includes a syntax-aware code search tool powered by tree-sitter. Unlike text-based search (grep), it understands code structure and finds actual functions, classes, methods, and other constructs—ignoring matches in comments and strings.
## Why Use Code Search?

View File

@@ -1,11 +1,11 @@
# G3 Control Commands
# g3 Control Commands
**Last updated**: January 2025
**Source of truth**: `crates/g3-cli/src/lib.rs`
## Purpose
Control commands are special commands you can use during an interactive G3 session to manage context, refresh documentation, and view statistics. They start with `/` and are processed by the CLI, not sent to the LLM.
Control commands are special commands you can use during an interactive g3 session to manage context, refresh documentation, and view statistics. They start with `/` and are processed by the CLI, not sent to the LLM.
## Available Commands
@@ -255,7 +255,7 @@ g3> /help
## Context Management Strategy
G3 automatically manages context, but manual intervention can help:
g3 automatically manages context, but manual intervention can help:
### Proactive Management
@@ -283,7 +283,7 @@ When context gets high:
## Automatic Context Management
G3 performs automatic context management:
g3 performs automatic context management:
| Threshold | Action |
|-----------|--------|

View File

@@ -1,11 +1,11 @@
# G3 Flock Mode Guide
# g3 Flock Mode Guide
**Last updated**: January 2025
**Source of truth**: `crates/g3-ensembles/src/flock.rs`
## Purpose
Flock mode enables parallel multi-agent development by spawning multiple G3 agent instances that work on different parts of a project simultaneously. This is useful for large projects with modular architectures where independent components can be developed in parallel.
Flock mode enables parallel multi-agent development by spawning multiple g3 agent instances that work on different parts of a project simultaneously. This is useful for large projects with modular architectures where independent components can be developed in parallel.
## Overview

View File

@@ -1,15 +1,15 @@
# G3 Architecture
# g3 Architecture
**Last updated**: January 2025
**Source of truth**: Crate structure in `crates/`, `Cargo.toml`, `DESIGN.md`
## Purpose
This document describes the internal architecture of G3, a modular AI coding agent built in Rust. It is intended for developers who want to understand, extend, or maintain the codebase.
This document describes the internal architecture of g3, a modular AI coding agent built in Rust. It is intended for developers who want to understand, extend, or maintain the codebase.
## High-Level Overview
G3 follows a **tool-first philosophy**: instead of just providing advice, it actively uses tools to read files, write code, execute commands, and complete tasks autonomously.
g3 follows a **tool-first philosophy**: instead of just providing advice, it actively uses tools to read files, write code, execute commands, and complete tasks autonomously.
```
┌─────────────────┐ ┌─────────────────┐ ┌─────────────────┐
@@ -58,7 +58,7 @@ G3 follows a **tool-first philosophy**: instead of just providing advice, it act
## Workspace Structure
G3 is organized as a Rust workspace with 9 crates:
g3 is organized as a Rust workspace with 9 crates:
```
g3/
@@ -234,7 +234,7 @@ Flock mode enables parallel development by spawning multiple agent instances wor
### studio (Multi-Agent Workspace Manager)
**Location**: `crates/studio/`
**Purpose**: Manage multiple G3 agent sessions using git worktrees
**Purpose**: Manage multiple g3 agent sessions using git worktrees
Key modules:
- `main.rs` - CLI commands (run, exec, list, status, accept, discard)
@@ -297,7 +297,7 @@ The `ContextWindow` struct manages conversation history with intelligent token t
## Error Handling
G3 implements comprehensive error handling:
g3 implements comprehensive error handling:
1. **Error Classification**: Distinguishes recoverable vs non-recoverable errors
2. **Automatic Retry**: Exponential backoff with jitter for:

View File

@@ -1,15 +1,15 @@
# G3 Configuration Guide
# g3 Configuration Guide
**Last updated**: January 2025
**Source of truth**: `crates/g3-config/src/lib.rs`, `config.example.toml`
## Purpose
This document explains how to configure G3, including provider setup, agent behavior, and optional features like WebDriver and computer control.
This document explains how to configure g3, including provider setup, agent behavior, and optional features like WebDriver and computer control.
## Configuration File Location
G3 looks for configuration files in this order:
g3 looks for configuration files in this order:
1. Path specified via `--config` CLI argument
2. `./g3.toml` (current directory)
@@ -20,7 +20,7 @@ If no configuration file exists, G3 creates a default one at `~/.config/g3/confi
## Configuration Format
G3 uses TOML format. The configuration is organized into sections:
g3 uses TOML format. The configuration is organized into sections:
```toml
[providers] # LLM provider settings
@@ -165,7 +165,7 @@ check_todo_staleness = true # Warn about stale TODO items
### Retry Behavior
G3 automatically retries on recoverable errors:
g3 automatically retries on recoverable errors:
- Rate limits (HTTP 429)
- Network errors
- Server errors (HTTP 5xx)

View File

@@ -1,11 +1,11 @@
# G3 LLM Providers Guide
# g3 LLM Providers Guide
**Last updated**: January 2025
**Source of truth**: `crates/g3-providers/src/`
## Purpose
This document describes the LLM providers supported by G3, their capabilities, and how to choose between them.
This document describes the LLM providers supported by g3, their capabilities, and how to choose between them.
## Provider Overview
@@ -269,10 +269,10 @@ threads = 8 # Use more threads
### Tool Calling
Embedded models don't have native tool calling. G3 uses JSON fallback:
Embedded models don't have native tool calling. g3 uses JSON fallback:
1. System prompt includes tool definitions as JSON
2. Model outputs tool calls as JSON in response
3. G3 parses JSON and executes tools
3. g3 parses JSON and executes tools
This works but is less reliable than native tool calling.
@@ -376,7 +376,7 @@ pub trait LLMProvider: Send + Sync {
### Rate Limits
G3 automatically retries on rate limits with exponential backoff.
g3 automatically retries on rate limits with exponential backoff.
To reduce rate limit issues:
- Use prompt caching (Anthropic)

View File

@@ -1,11 +1,11 @@
# G3 Tools Reference
# g3 Tools Reference
**Last updated**: January 2025
**Source of truth**: `crates/g3-core/src/tool_definitions.rs`, `crates/g3-core/src/tools/`
## Purpose
This document describes all tools available to the G3 agent. Tools are the primary mechanism by which G3 interacts with the filesystem, executes commands, and automates tasks.
This document describes all tools available to the g3 agent. Tools are the primary mechanism by which g3 interacts with the filesystem, executes commands, and automates tasks.
## Tool Categories
@@ -445,7 +445,7 @@ List all open windows with IDs and titles.
### Duplicate Detection
G3 prevents accidental duplicate tool calls:
g3 prevents accidental duplicate tool calls:
- Only immediately sequential identical calls are blocked
- Text between tool calls resets detection
- Tools can be reused throughout a session