24 lines
1.2 KiB
Markdown
24 lines
1.2 KiB
Markdown
|
# AGENTS.md
|
||
|
|
|
||
|
|
## Project Structure
|
||
|
|
|
||
|
|
This repository is mainly a curated notes collection.
|
||
|
|
Currently, main content lives in:
|
||
|
|
|
||
|
|
- `hassan/`: Geolog- and logic-related notes.
|
||
|
|
- `hqew/`: cleaned notes on query engines and related architecture topics.
|
||
|
|
- `scratches/`: working drafts, diagrams, and exploratory material.
|
||
|
|
- `tmp/`: local source material and downloads. It is ignored by Git and should not be referenced from durable notes.
|
||
|
|
|
||
|
|
Root configuration is minimal: `pyproject.toml` defines a lightweight Python environment, `.editorconfig` sets formatting defaults, and `.gitignore`
|
||
|
|
excludes local artifacts.
|
||
|
|
|
||
|
|
## Writing Style
|
||
|
|
|
||
|
|
- Use Oxford commas in inline lists: "a, b, and c" not "a, b, c".
|
||
|
|
- Do not use em dashes. Restructure the sentence, or use a colon or semicolon instead.
|
||
|
|
- Avoid colorful adjectives and adverbs. Write "TCP proxy" not "lightweight TCP proxy", "scoring components" not "transparent scoring components".
|
||
|
|
- Use noun phrases for checklist items, not imperative verbs. Write "redundant index detection" not "detect redundant indexes".
|
||
|
|
- Headings in Markdown files must be in the title case: "Build from Source" not "Build from source". Minor words (a, an, the, and, but, or, for, in,
|
||
|
|
on, at, to, by, of) stay lowercase unless they are the first word.
|