# Repository Guidelines ## Project Structure & Note Organization - Core notes: `notes/`, domain pages in `pages/`, research inputs in `papers/`, highlights in `Clippings/`, books in `books/`. - Intake: drop rough ideas in `00_inbox/`; file to a destination later. - Periodic notes: `z95_periodic-notes/`, journals in `journals/`. - Templates: `z98_templates/` for new note scaffolds; diagrams in `Excalidraw/`. - Assets: images and PDFs in `Attachments/`. Link with `![[file.png]]` or ``. ## Workflow & Commands - Search: `rg -n "keyword" notes/ papers/` to find references. - Create/move: `git mv 00_inbox/idea.md notes/topic/idea.md` to keep history. - Sync: `git add -A && git commit -m "notes: add X" && git push`. - Publish (if used): site styles/scripts live in `publish.css` and `publish.js`. ## Markdown Style & Naming - Frontmatter: use YAML when metadata helps. ```yaml --- title: Short Title tags: [topic, project] --- ``` - Headings: start with a single `#` title per file; use `##` for sections. - Links: prefer `[[Note Title]]` for internal, full URLs for external. - Filenames: `YYYY-MM-DD-title.md` for dated entries; `kebab-case.md` for evergreen notes. ## Templates & Reuse - Start new notes from `z98_templates/` (e.g., `research-note.md`, `paper-summary.md`). - Place reusable snippets or prompts in `copilot-custom-prompts/` for sharing. ## Commit & Pull Request Guidelines - Messages: `<area>: <imperative>` (e.g., `notes: add reactive systems summary`). - Scope keywords: `notes|papers|books|Clippings|pages|structures|z95`. - PRs: include a short description, key links (`[[refs]]` or URLs), and before/after screenshots for visual changes. ## Security & Configuration Tips - Sensitive content: store private materials in `z99_private/`; avoid secrets in public branches. - Large files: keep binaries in `Attachments/`. Consider Git LFS if size grows. - Consistency: use the same Obsidian plugins/config across machines (see `.obsidian/`).