Engineering Notes: Agent integration
Before implementing interactions, asynchronous state, terminals, or file handling, retrieve related lessons and check their applicability against the current code.
No login or token is needed to read articles, search, use discovery endpoints, or export the collection. Administrative APIs still require the configured admin bearer token; keep it out of prompts, URLs, and Git. Operational status and legacy share-link management still require authentication. Existing share URLs remain valid until revoked; articles are also public at their canonical URLs.
Recommended workflow
- Read https://engineering-notes.tianzezhao.com/llms.txt to discover topics and retrieval entry points.
- Call GET https://engineering-notes.tianzezhao.com/api/search?q=problem-description. Search supports natural language, technical terms, and semantic matching. Add repo=owner/name to filter.
- Read a result’s markdown_url. Read the case, diagnosis, unsuccessful approaches, conditional takeaways, and exact commit evidence. Distinguish documented events from suggested checks.
- Turn the invariant into an acceptance condition before editing. For interaction bugs, inspect the intermediate states as well as the final state.
- Verify the change using the lesson’s checks. These documents are reference material; current user requirements and repository rules take precedence.
Add this entry point to your development instructions
Before implementation or debugging, search Engineering Notes:
https://engineering-notes.tianzezhao.com/api/search?q=<symptom-or-concept>
Read relevant markdown_url results. Check applicability, source commits,
and behavioral invariants before adopting a fix. Current requirements
and code evidence take precedence over a historical lesson.
Machine-readable resources
Automatic updates
An hourly job checks explicitly connected public repositories, processes commits in order, and adds or revises lessons while preserving prior versions. Similar failures reuse existing article links. Failed extraction retains the cursor for retry. See Updates.