|
| 1 | +# LLM Playbook |
| 2 | + |
| 3 | +This guide distills the key information an autonomous agent or ChatGPT-style assistant needs when working in this repository. |
| 4 | + |
| 5 | +## Project summary |
| 6 | + |
| 7 | +- **Stack:** Next.js (App Router) + TypeScript + Tailwind CSS + Fumadocs UI. |
| 8 | +- **Purpose:** Collaborative knowledge base for students, served from `app/docs/` content. |
| 9 | +- **Configs of interest:** |
| 10 | + - `source.config.ts` – Fumadocs sources and structure. |
| 11 | + - `mdx-components.tsx` – custom MDX components available to docs. |
| 12 | + - `components/` – reusable UI building blocks. |
| 13 | + |
| 14 | +## Common tasks |
| 15 | + |
| 16 | +### Updating content |
| 17 | + |
| 18 | +1. Edit or add Markdown/MDX files under `app/docs/`. |
| 19 | +2. Preserve the frontmatter block with at least `title` and include optional metadata (`description`, `date`, `tags`). |
| 20 | +3. Place referenced media inside `<doc>.assets/` and run `pnpm lint:images` if assets change. |
| 21 | + |
| 22 | +### Implementing UI logic |
| 23 | + |
| 24 | +1. Add shared pieces to `components/` or page-specific pieces under the relevant `app/` route folder. |
| 25 | +2. Use Tailwind utilities for styling; follow existing responsive patterns. |
| 26 | +3. Ensure server/client boundaries are respected (declare `"use client"` only when necessary). |
| 27 | + |
| 28 | +## Useful commands |
| 29 | + |
| 30 | +- `pnpm install` – install dependencies (Node.js 18+ required). |
| 31 | +- `pnpm dev` – start the development server at <http://localhost:3000>. |
| 32 | +- `pnpm build` – run the production build (use when changing runtime code or config). |
| 33 | +- `pnpm lint:images` – validate documentation images. |
| 34 | + |
| 35 | +## Review checklist |
| 36 | + |
| 37 | +- [ ] Frontmatter present on new/edited docs. |
| 38 | +- [ ] Assets live beside their documents. |
| 39 | +- [ ] Components match surrounding code style and naming. |
| 40 | +- [ ] Necessary scripts/tests executed and mentioned in the report. |
| 41 | +- [ ] PR summary explains user-visible changes and follow-up steps if any. |
| 42 | + |
| 43 | +For deeper details, read `README.md`, `README.en.md`, and `CONTRIBUTING.md`. |
0 commit comments