You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Welcome! This repository hosts the Involution Hell documentation site, built with Next.js App Router, Fumadocs UI, TypeScript, and Tailwind CSS. Follow the instructions below whenever you contribute changes.
4
+
5
+
## General workflow
6
+
7
+
- Prefer `pnpm` for all Node.js commands (`pnpm install`, `pnpm dev`, `pnpm build`, etc.).
8
+
- Keep changes focused and provide helpful descriptions in commits and PR messages.
9
+
- When adding dependencies, ensure they are compatible with Node.js 18+.
10
+
11
+
## Coding standards
12
+
13
+
- Follow existing patterns in the codebase; align new components with the established structure under `app/` and `components/`.
14
+
- Use TypeScript (`.ts` / `.tsx`) and Tailwind CSS utility classes for styling unless a file already uses a different approach.
15
+
- Avoid unnecessary abstractions; keep components small, composable, and accessible.
16
+
- Do not wrap imports in `try/catch` blocks.
17
+
18
+
## Documentation & content
19
+
20
+
- All documentation lives under `app/docs/` (folder-as-book). Each Markdown/MDX file **must** retain a frontmatter block with at least a `title`.
21
+
- Place images referenced by a document inside the document’s sibling `*.assets/` folder. Use the provided image migration scripts if needed.
22
+
- Prefer relative links within the docs unless cross-referencing an external resource.
23
+
24
+
## Testing & validation
25
+
26
+
- Run relevant scripts before submitting changes. Common checks include:
27
+
-`pnpm dev` for local verification.
28
+
-`pnpm build` for production validation when you touch runtime logic.
29
+
-`pnpm lint:images` when you add or move media assets.
30
+
31
+
## PR expectations
32
+
33
+
- Summarize user-facing changes clearly.
34
+
- Mention any new scripts, configuration, or docs that reviewers should be aware of.
35
+
36
+
For additional details, consult `README.md` and `CONTRIBUTING.md`.
0 commit comments