notes AGENTS.md

Project instructions for Notes, a TIL website: “Today I Learned” means a collection of short notes about things someone has learned. The instructions cover its Docusaurus and TypeScript setup, content folders, formatting, and commits.

In plain words
What is it for?
Use them when adding or editing Markdown or MDX notes, running the development server or build, checking code style, or making commits.
Why use it?
They tell a coding agent where notes belong and which structure and metadata they must use. This avoids broken navigation, invalid content, and inconsistent changes.

Instructions file for CodexOpenCode

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add instructions/sabertaz/notes/agents-md
Clone the repo
git clone --depth 1 https://github.com/sabertaz/notes

Made for: Codex, OpenCode.

Per session 583 This file is loaded in full into every session.
When invoked 583 The same file — it is already loaded in full.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.00583 $0.00583
Opus 5 $0.00292 $0.00292
Sonnet 5 $0.00117 $0.00117
Haiku 4.5 $0.00058 $0.00058

Measured 2d ago against content hash 99cc2ebb0aa9, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

notes AGENTS.md scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 2d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

AGENTS.md · 56 lines

How it starts

The opening of the file, as written. The whole thing — 56 lines — stays where its author put it; the contents beside it link to each section on GitHub.

AGENTS.md

This file provides guidance to coding agents when working with code in this repository.

Project Overview

Notes is a TIL (Today I Learned) documentation website built with Docusaurus. It serves as a comprehensive knowledge repository covering AI, CS, web, programming, and more.

Tech Stack: Docusaurus + TypeScript + shadcn + pnpm + React

Structure: content/{AI,CS,Web,Language,Programming}/{topic}/{file}.md

Development Commands

Command Description
pnpm dev Start dev server
pnpm build Build for production
pnpm lint Run all linters
pnpm lint:fix Auto-fix issues

Content Guidelines

  • Notes are Markdown files in content/ directory
  • Require frontmatter: tags: [Category, Subcategory]
  • Supports MDX, KaTeX math ($inline$, $$block$$), Mermaid diagrams
  • Sidebar autogenerated from directory structure

Commit Guidelines

Follows Conventional Commits format:

  • Types: feat (new note or domain), fix (updates to existing notes), perf, test, ci, chore
  • Scope:
    • CRITICAL: Only 1-2 levels allowed, maximum one - separator
    • Single file: Extract from filename omitting top-level (e.g. react-hooks)
    • Multi-area changes: Use top-level category (e.g., web-react, cs-algorithm)
  • Description: the actual knowledge/concept name, extracted from headings, code examples, or explanatory text
  • Key principle:
    • NEVER use structural words like section, content, notes in description
    • NEVER use action verbs like add, update, remove, delete, modify in description

Examples:

File Path Scope (1-2 levels only) Description
content/web/react/hooks/event.md react-hooks useEffectEvent latest value
content/language/rust/ownership.md rust-ownership borrow checker rules
content/cs/algorithm/sort.md algorithm-sort quick sort partition
content/ai/gen/gpt.md + content/ai/gen/claude-code.md ai-gen comparison of models

Read the full file on GitHub · 56 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 2d ago First seen · 56 lines · 583 tokens per session scan A 99cc2ebb0aa9

Subscribe to this mod's changes

notes AGENTS.md is an instructions file published in the GitHub repository sabertaz/notes (48 stars, last pushed 18d ago), licensed MIT. It adds 583 tokens to every session, about $0.0029 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.

Related

Other instructions, from other repositories

electron CLAUDE.md

Instructions for electron/electron, covering electron development guide, running nodemodules binaries, project overview, directory structure and build tools setup.

electron/electron · 2,653 tokens

electron copilot-instructions.md

Instructions for electron/electron, covering copilot instructions for electron, build system, linting, running a single test and example: npm run test -- -g "ipc".

electron/electron · 1,178 tokens

KarmaCircle AGENTS.md

Instructions for karmacircleCommunity/KarmaCircle, covering agentic workflow, git / branching, the apps/web ↔ apps/api boundary, repo-specific guardrails and when you're not sure which duplicate a request means.

karmacircleCommunity/KarmaCircle · 1,466 tokens

KarmaCircle CLAUDE.md

Instructions for karmacircleCommunity/KarmaCircle, covering monorepo layout, graphify — check the knowledge graph first, caveman — always run ultra mode in this repo, git workflow and responsive design — mandatory for every component.

karmacircleCommunity/KarmaCircle · 4,196 tokens

mis-recursos-webdev AGENTS.md

Instructions for Alplox/mis-recursos-webdev, covering agents.md — mis recursos web dev, 📋 stack, 🏗️ estructura del proyecto, 🧠 source of truth and estructura del readme.

Alplox/mis-recursos-webdev · 2,790 tokens

webf CLAUDE.md

Claude Code instructions for openwebf/webf, covering webf development guide, 📚 folder-specific guides, 🚀 quick start, repository structure and common commands.

openwebf/webf · 1,778 tokens