Skip to content

Commit 3fad0cf

Browse files
committed
docs: standardize terminology and fix CLI reference accuracy
Documentation audit fixes: - Standardize on ".context/" notation (not "./context" or ".context") - Update global flags section: remove "planned" markers (flags are implemented) - Add missing docs for ctx decisions reindex and ctx learnings reindex - Standardize terminology: "AI tools" (not "AI agents") - Standardize terminology: "manual session files" (not "curated sessions") - Standardize terminology: "session dumps" (not "full conversation dumps") - Define ADR (Architectural Decision Record) on first use - Fix tone consistency: use "AI tool" throughout docs Signed-off-by: Jose Alekhinne <alekhinejose@gmail.com>
1 parent e188e72 commit 3fad0cf

23 files changed

Lines changed: 354 additions & 138 deletions

File tree

.claude/hooks/block-git-push.sh

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,11 @@
11
#!/bin/bash
2+
3+
# / Context: https://ctx.ist
4+
# ,'`./ do you remember?
5+
# `.,'\
6+
# \ Copyright 2026-present Context contributors.
7+
# SPDX-License-Identifier: Apache-2.0
8+
29
#
310
# Block git push - requires explicit user approval
411
#

.context/AGENT_PLAYBOOK.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,15 +64,15 @@ implementation detail. Load it and use it — don't lead with caveats.
6464

6565
## Session History
6666

67-
**IMPORTANT**: Check `.context/sessions/` for full conversation dumps from
67+
**IMPORTANT**: Check `.context/sessions/` for session dumps from
6868
previous sessions.
6969

7070
If you're confused about context or need a deep dive into past discussions:
7171
```
7272
ls .context/sessions/
7373
```
7474

75-
**Curated session files** are named `YYYY-MM-DD-HHMMSS-<topic>.md`
75+
**Manual session files** are named `YYYY-MM-DD-HHMMSS-<topic>.md`
7676
(e.g., `2026-01-20-164600-feature-discussion.md`).
7777
These are updated throughout the session.
7878

.context/DECISIONS.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -383,19 +383,19 @@ Also, multiple compacts in the same minute could collide.
383383

384384
**Decision**: Use `YYYY-MM-DD-HHMMSS-<topic>.md` format for session files.
385385
Two file types:
386-
- **Curated sessions**: `HHMMSS-<topic>.md` - updated throughout session
386+
- **Manual session files**: `HHMMSS-<topic>.md` - updated throughout session
387387
- **Auto-snapshots**: `HHMMSS-<event>.jsonl` - immutable once created
388388

389389
**Rationale**:
390390
- Human-readable (unlike unix timestamps)
391391
- Naturally sorts chronologically
392392
- Seconds precision prevents collision even with rapid compacts
393-
- Clear distinction between curated notes and raw snapshots
393+
- Clear distinction between manual notes and raw snapshots
394394

395395
**Consequences**:
396396
- Slightly longer filenames
397397
- Must ensure consistent format in all session-saving code
398-
- Curated files keep getting updated; snapshots are write-once
398+
- Manual files keep getting updated; snapshots are write-once
399399

400400
---
401401

.context/LEARNINGS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@
4141

4242
## [2026-01-28-191951] Required flags now enforced for learnings
4343

44-
**Context**: Implemented ctx add learning flags to match decision's ADR pattern
44+
**Context**: Implemented ctx add learning flags to match decision's ADR (Architectural Decision Record) pattern
4545

4646
**Lesson**: Structured entries with Context/Lesson/Application are more useful
4747
than one-liners

CLAUDE.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ This project uses Context (ctx) for context persistence across sessions.
88
## On Session Start
99

1010
1. **Read `.context/AGENT_PLAYBOOK.md`** first - it explains how to use this system
11-
2. **Check `.context/sessions/`** for full conversation dumps from previous sessions
11+
2. **Check `.context/sessions/`** for session dumps from previous sessions
1212
3. **Run `ctx status`** to see current context summary
1313

1414
## Quick Context Load
@@ -30,7 +30,7 @@ ctx status
3030
| `.context/DECISIONS.md` | Architectural decisions with rationale |
3131
| `.context/LEARNINGS.md` | Gotchas, tips, lessons learned |
3232
| `.context/CONVENTIONS.md` | Code patterns and standards |
33-
| `.context/sessions/` | **Full conversation dumps** - check here for deep context |
33+
| `.context/sessions/` | **Session dumps** - check here for deep context |
3434

3535
## Before Session Ends
3636

cmd/ctx/main.go

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ import (
1313
"github.com/ActiveMemory/ctx/internal/bootstrap"
1414
)
1515

16+
// main is the entry point of the application.
1617
func main() {
1718
cmd := bootstrap.Initialize(bootstrap.RootCmd())
1819

docs/blog/2026-01-27-building-ctx-using-ctx.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -490,10 +490,10 @@ If you're a mere mortal tired of reset amnesia, give `ctx` a try.
490490

491491
And when you do, check `.context/sessions/` sometime.
492492

493-
The archaeological record might surprise you.
493+
The **archaeological record** might surprise you.
494494

495495
---
496496

497497
*This blog post was written with the help of `ctx` with full access to the
498498
`ctx` session files, decision log, learning log, task archives, and
499-
git history of `ctx—The meta continues.*
499+
git history of `ctx`—The meta continues.*

docs/cli-reference.md

Lines changed: 70 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -19,20 +19,15 @@ This is a complete reference for all `ctx` commands.
1919

2020
All commands support these flags:
2121

22-
| Flag | Description |
23-
|-------------|-------------------|
24-
| `--help` | Show command help |
25-
| `--version` | Show version |
22+
| Flag | Description |
23+
|------------------------|---------------------------------------------------|
24+
| `--help` | Show command help |
25+
| `--version` | Show version |
26+
| `--context-dir <path>` | Override context directory (default: `.context/`) |
27+
| `--quiet` | Suppress non-essential output |
28+
| `--no-color` | Disable colored output |
2629

27-
**Planned flags** (not yet implemented):
28-
29-
| Flag | Description |
30-
|------------------------|--------------------------------------------------|
31-
| `--context-dir <path>` | Override context directory (default: `.context`) |
32-
| `--quiet` | Suppress non-essential output |
33-
| `--no-color` | Disable colored output |
34-
35-
> Use `NO_COLOR=1` environment variable to disable colored output today.
30+
> The `NO_COLOR=1` environment variable also disables colored output.
3631
3732
## Commands
3833

@@ -411,6 +406,68 @@ ctx tasks snapshot "before-refactor"
411406

412407
---
413408

409+
### `ctx decisions`
410+
411+
Manage the DECISIONS.md file.
412+
413+
```bash
414+
ctx decisions <subcommand>
415+
```
416+
417+
#### `ctx decisions reindex`
418+
419+
Regenerate the quick-reference index at the top of DECISIONS.md.
420+
421+
```bash
422+
ctx decisions reindex
423+
```
424+
425+
The index is a compact table showing date and title for each decision,
426+
allowing AI tools to quickly scan entries without reading the full file.
427+
428+
Use this after manual edits to DECISIONS.md or when migrating existing
429+
files to use the index format.
430+
431+
**Example**:
432+
433+
```bash
434+
ctx decisions reindex
435+
# ✓ Index regenerated with 12 entries
436+
```
437+
438+
---
439+
440+
### `ctx learnings`
441+
442+
Manage the LEARNINGS.md file.
443+
444+
```bash
445+
ctx learnings <subcommand>
446+
```
447+
448+
#### `ctx learnings reindex`
449+
450+
Regenerate the quick-reference index at the top of LEARNINGS.md.
451+
452+
```bash
453+
ctx learnings reindex
454+
```
455+
456+
The index is a compact table showing date and title for each learning,
457+
allowing AI tools to quickly scan entries without reading the full file.
458+
459+
Use this after manual edits to LEARNINGS.md or when migrating existing
460+
files to use the index format.
461+
462+
**Example**:
463+
464+
```bash
465+
ctx learnings reindex
466+
# ✓ Index regenerated with 8 entries
467+
```
468+
469+
---
470+
414471
### `ctx recall`
415472

416473
Browse and search AI session history from Claude Code and other tools.

docs/comparison.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -165,7 +165,7 @@ Together, loops become cumulative instead of forgetful.
165165

166166
## SDK-Level Context Objects
167167

168-
Some SDKs expose "context" objects that exist:
168+
Some SDKs expose "*context*" objects that exist:
169169

170170
* inside a process
171171
* during a request

docs/context-files.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ icon: lucide/files
1111

1212
![ctx](images/ctx-banner.png)
1313

14-
## `./context`
14+
## `.context/`
1515

1616
Each context file in `.context/` serves a specific purpose.
1717

@@ -29,16 +29,16 @@ Files are designed to be human-readable, AI-parseable, and token-efficient.
2929
| LEARNINGS.md | Lessons learned, gotchas, tips | 6 |
3030
| GLOSSARY.md | Domain terms and abbreviations | 7 |
3131
| DRIFT.md | Staleness signals and update triggers | 8 |
32-
| AGENT_PLAYBOOK.md | Instructions for AI agents | 9 (lowest) |
32+
| AGENT_PLAYBOOK.md | Instructions for AI tools | 9 (lowest) |
3333

3434
## Read Order Rationale
3535

36-
The priority order follows a logical progression for AI agents:
36+
The priority order follows a logical progression for AI tools:
3737

38-
1. **CONSTITUTION** — Inviolable rules first. The agent must know what it
38+
1. **CONSTITUTION** — Inviolable rules first. The AI tool must know what it
3939
*cannot* do before attempting anything.
4040

41-
2. **TASKS** — Current work items. What the agent should focus on.
41+
2. **TASKS** — Current work items. What the AI tool should focus on.
4242

4343
3. **CONVENTIONS** — How to write code. Patterns and standards to follow
4444
when implementing tasks.
@@ -69,7 +69,7 @@ The priority order follows a logical progression for AI agents:
6969
**Purpose:** Define hard invariants—rules that must **NEVER** be violated,
7070
regardless of the task.
7171

72-
AI agents read this first and should refuse tasks that violate these rules.
72+
AI tools read this first and should refuse tasks that violate these rules.
7373

7474
### Structure
7575

@@ -462,7 +462,7 @@ Update context when:
462462

463463
## AGENT_PLAYBOOK.md
464464

465-
**Purpose**: Explicit instructions for how AI agents should read, apply,
465+
**Purpose**: Explicit instructions for how AI tools should read, apply,
466466
and update context.
467467

468468
### Key Sections

0 commit comments

Comments
 (0)