Claude Code Ultimate Guide - Project Context
## Purpose
This repository is the **comprehensive documentation for Claude Code** (Anthropic's CLI tool). It teaches users how to use Claude Code effectively through
6.3k16d agoReviewMountCreate a free account to mount
user-visible, **add the entry** and let the maintainer remove it if not needed.
## Documentation site
Tutorials live in [Docs/](Docs/) as Markdown and are published to a DocFX site
6.3k5mo agoReviewMountCreate a free account to mount
relicense it from here.
## Architecture
Current module boundaries and dependency rules are documented below; each module's `CLAUDE.md` and `docs/` describe its implementation. The original [master plan](./docs/archive/PJ4_PLAN.md) is retired
6.3k56d agoReviewMountCreate a free account to mount
enable_when` is. |
| `pjFollowTail` (bool) | `QPlainTextEdit` | The widget is a transcript/log rather than a document: its first population and any wholesale replacement (another conversation swapped in) open on the newest
6.3k56d agoReviewMountCreate a free account to mount
show seam. **Loader-metadata registry:** `setDatasetMetadata`/`datasetMetadata`/`clearDatasetMetadata` hold one loader-supplied JSON document per dataset (attributed to the emitting plugin; bounds in `validateDatasetMetadata` — object root, ≤1 MiB, depth
6.3k56d agoReviewMountCreate a free account to mount
compute-shader compaction path (`glDrawElementsIndirect` over only the
accepted voxels, GL ≥ 4.3) is a documented follow-up for very large dense grids.
Depth images arrive as `sdk::Image` with
6.3k56d agoReviewMountCreate a free account to mount
optional. Guard their imports with `is_available()`.
Optional features and installation groups are documented in [`docs/installation.md`](docs/installation.md).
## Test and lint
`maintain.sh` scopes Pyright to `src/`, because full-project Pyright exhausts
6.2k6d agoReviewMountCreate a free account to mount
parameter tables
4. The drone-ssh binary handles the actual parameter logic (separate repo)
### Documentation
- Keep parameter tables in README.md synchronized with `action.yml`
- Maintain Chinese translations (README.zh-cn.md, README.zh-tw.md)
- Use clear
Steady4 mentions in 2 weeks
No other project uses it yet
6.2k3mo agoReviewMountCreate a free account to mount
Library work should not require bot dependencies or changes to its deployment.
Edit handwritten documentation in `docs/`. API reference pages are generated from Python signatures and docstrings:
```bash
6.2k6d agoReviewMountCreate a free account to mount
technical publishing system built on Pandoc. The CLI is TypeScript/Deno with Lua filters for document processing.
- Latest stable version: <https://quarto.org/docs/download/_download.json>
- Latest prerelease version: <https://quarto.org/docs/download/_prerelease.json>
## Setup
```bash
6.1k3d agoReviewMountCreate a free account to mount
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
6k18d agoReviewMountCreate a free account to mount
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
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.