Skip to content

Commit 0d340da

Browse files
committed
docs: add documentation date-time stamping guidelines
Add new section to CLAUDE.md outlining requirements for including date-time stamps in markdown files to track document freshness and prevent staleness. Includes examples for filenames, section headers, and status updates.
1 parent 56a76f0 commit 0d340da

File tree

5 files changed

+6
-882
lines changed

5 files changed

+6
-882
lines changed

CLAUDE.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,12 @@ Atlas UI 3 is a full-stack LLM chat interface with Model Context Protocol (MCP)
1616

1717
No Emojis should ever be added in this repo. If you find one, then remove it.
1818

19-
**File Naming**: Do not use generic names like `main.py`, `cli.py`, `utils.py`, or `helpers.py`. Use descriptive names that reflect the file's purpose (e.g., `chat_service.py`, `mcp_tool_manager.py`, `websocket_handler.py`). Exception: top-level entry points like `backend/main.py` are acceptable.
19+
**File Naming**: Do not use generic names like `main.py`, `cli.py`, `utils.py`, or `helpers.py`. Use descriptive names that reflect the file's purpose (e.g., `chat_service.py`, `mcp_tool_manager.py`, `websocket_handler.py`). Exception: top-level entry points like `backend/main.py` are acceptable.
20+
21+
**Documentation Date-Time Stamping**: When creating markdown (.md) files, always include date-time stamps either in the filename or as a header in key sections to help track if docs are stale. Format: `YYYY-MM-DD` or `YYYY-MM-DD HH:MM`. Examples:
22+
- Filename: `feature-plan-2025-11-02.md`
23+
- Section header: `## Implementation Plan (2025-11-02)`
24+
- Status update: `Last updated: 2025-11-02 14:30`
2025

2126
# Tests
2227

docs/refactoring-complete-summary.md

Lines changed: 0 additions & 236 deletions
This file was deleted.

0 commit comments

Comments
 (0)