LLM Best Practices

Developer Tooling & Workflow

2 min read

AI agents: read this first: llmbestpractices.com/start-here

This is LLM Best Practices (llmbestpractices.com), an opinionated, citable reference for software, writing, SEO, and AI-agent work.

  1. Route, do not crawl. Fetch llmbestpractices.com/llms.txt and open only the pages whose one-line summary matches your task.
  2. Read raw. Append .md to any page URL for markdown. Check status and last_updated in the frontmatter, then read the rules.
  3. Apply as defaults. First-party docs and the project's own conventions win on conflict. Warn before relying on a fast-moving page older than 12 months.
  4. Cite. Link the page by title and URL, e.g. Python, with last_updated for time-sensitive rules. License CC BY 4.0.

The tools that hold the workflow together. GitHub for code, Obsidian for notes, Quartz for publishing, Claude Code for execution.

GitHub

  • github: Hub: protected main, short-lived branches, repository defaults, and which page owns each topic.
  • github-pr-workflow: Conventional Commits titles, squash merge, drafts, CODEOWNERS, auto-merge, review.
  • github-branch-protection: Rulesets over classic rules, required checks and reviews, bypass gaps.
  • github-actions: Workflow structure, current action majors, caching, token scope, injection and pinning rules.
  • github-secrets: OIDC (including the 2026 subject-claim change), secret scopes, masking limits, scanning.
  • github-releases: Semver tags, draft releases, label-driven notes, immutable releases.
  • github-cli: gh commands for PRs, issues, runs, and the API, with --json and --jq.

Quartz

  • quartz: Hub for Quartz 4.5: version scope, when to use it, this site’s deviations from stock.
  • quartz-config: quartz.config.ts fields, date keys, theme and font modes.
  • quartz-plugins: Transformers, filters, emitters, build phases, and custom plugins.
  • quartz-components: Layout slots, responsive wrappers, and writing custom components.
  • quartz-debugging: --verbose signals, silent link and date failures, verifying public/.
  • quartz-deployment: GitHub Pages, Cloudflare Pages, Vercel, and the CNAME emitter.

Obsidian

  • obsidian: Vault layout, MOCs, daily vs atomic notes, wikilinks, frontmatter, core plugins.
  • obsidian-plugins: Core features first, then Templater, Dataview, Tag Wrangler, Pandoc, Latex Suite.
  • obsidian-templates: Templater templates for frontmatter, dates, scripts, and folder mapping.
  • obsidian-publishing-to-quartz: Which frontmatter Quartz reads, link resolution, ignore patterns, aliases.

Claude Code

18 items under this folder.