You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This directory contains documentation written for LLM assistants working on the Quarto codebase.
4
+
5
+
## Staleness Check
6
+
7
+
Each document has YAML frontmatter with analysis metadata:
8
+
9
+
```yaml
10
+
---
11
+
main_commit: abc1234 # merge-base with main (stable reference)
12
+
analyzed_date: 2025-01-22
13
+
key_files:
14
+
- path/to/file1.ts
15
+
- path/to/file2.lua
16
+
---
17
+
```
18
+
19
+
**Why merge-base?** Branch commits can be rebased or disappear. The merge-base with main is stable and represents the baseline from main that was analyzed.
20
+
21
+
**Before relying on a document**, check if key files have changed:
If there are significant changes, re-explore the codebase and update the document.
28
+
29
+
## Updating Documents
30
+
31
+
After re-analyzing, update the frontmatter:
32
+
33
+
```bash
34
+
# Get merge-base with main (use upstream/main if that's the main remote)
35
+
git merge-base HEAD main | cut -c1-9
36
+
```
37
+
38
+
Then update `main_commit`, `analyzed_date`, and verify `key_files` list is complete.
39
+
40
+
**Date verification:** Before writing dates, check today's date from the system environment (shown at conversation start). This avoids year typos like writing 2025 when it's 2026.
41
+
42
+
## Document Purpose
43
+
44
+
These docs capture architectural understanding that would otherwise require extensive codebase exploration. They are NOT:
45
+
- User documentation (that's at quarto.org)
46
+
- Code comments (those live in source files)
47
+
- Issue-specific notes (those go in PR descriptions)
0 commit comments