observability platform built on OpenTelemetry. This repository contains the Python SDK for Logfire and documentation. The server application for recording and displaying data is closed source.
Key aspects:
- Opinionated wrapper
Agent framework documentation
These guides must describe integrations that users can reproduce. Treat every code sample and support claim as
product behavior, not illustrative pseudocode.
## Required standard
- Use the framework
claude.ai/code) when working with code in this repository.
## Important
- ALL instructions within this document MUST BE FOLLOWED, these are not optional unless explicitly stated.
- ASK FOR CLARIFICATION
Repository guide for coding agents
Macro is a document and collaboration app with a Rust backend and a web frontend.
This file is the shared entry point: `AGENTS.md` symlinks
Examples in `examples/`
### Code Standards
- All code comments must be written in English
- All documentation must be written in Chinese
### Dependencies
- Go 1.23+ required
- Uses Cobra for CLI
- Integrates with
Usage Patterns
kubefwd is commonly integrated into development workflows:
- **With Tilt**: Blog posts document using kubefwd with Tilt for automated local development setups
- **Development Environment Setup**: Teams use kubefwd
provider identity, capabilities,
authentication mode, detection, and health routing. Use
`scripts/helpers/check-providers.sh` for the documented machine-readable
admission protocol or `scripts/helpers/preflight.sh --json` for structured
readiness objects.
Static checks are local-only
whole thing. Do it right. Do it with tests. Do it with documentation. Do it so well that Ben is genuinely impressed — not politely satisfied, actually impressed. Never offer
test section of @.github/workflows/ci.yml)
### Comments
- Comments MUST only be used to:
1. Document a function
2. Explain the WHY of a piece of code
3. Explain a particularly complicated piece
naming `pip install anthropic[ ]` (`MissingDependencyError`).
### Breaking changes
- **Anything importable without an underscore is public,** documented or not. So new modules, attributes, and parameters start private and are made public
stale descriptions break discovery.
## Branding: NotFair
The product is **NotFair**. All user-facing text, documentation, skill descriptions, and config namespaces use NotFair / `notfair.co` / `.notfair/`. The prior brand has been fully
file shell blocks: `.github/tests/test_instruction_python_c_census.py`).
Exception: when the skill itself shows the modification (e.g. a documented `| tee logfile` pattern), follow what the skill prints.
---
## SLASH-COMMAND DISPATCH
When a `/command` fires
coreutils. Pin GNU with docker
(`debian:stable-slim`) before changing semantics and document a divergence
where it lives. Exit codes and stderr wording are part of the contract.
- **`CommandSpec`, `Operand
reads this file automatically and follows the workflows below.
---
## Directory Layout
```
raw/ # Immutable source documents — never modify these
wiki/ # Claude owns this layer entirely
index.md # Catalog of all pages — update
prod_pg(sql)`, `search_objects_staging_mysql(...)`)
- See `dbhub.toml.example` for complete configuration reference
- Documentation: https://dbhub.ai/config/toml
### 2. Environment Variables (Single Database)
- Copy `.env.example` to `.env` and configure for your
detailed architecture, see [ARCHITECTURE.md](ARCHITECTURE.md). For development setup and processes, see [CONTRIBUTING.md](CONTRIBUTING.md).
## Documentation Index
This guide has been split into focused sub-documents for progressive disclosure:
| Document | Description |
| ------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| [[CLAUDE-PATTERNS.md
A file Claude Code reads at the start of every session. It holds the commands, conventions and warnings the agent needs for this project.
Where does it go?
At the repository root. Claude Code also reads CLAUDE.md files in subdirectories when it works there.
What should it contain?
Build and test commands, the project's layout, conventions that aren't obvious from the code, and mistakes to avoid. Short files tend to work better than long ones.
CLAUDE.md or AGENTS.md?
Claude Code reads CLAUDE.md; most other agents read AGENTS.md. Many projects keep one and point the other at it.