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
Copy file name to clipboardExpand all lines: .claude/CLAUDE.md
+25-16Lines changed: 25 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
-
# CLAUDE.md — React Native Project
1
+
# CLAUDE.md — React Native Starter
2
2
3
-
**Claude Code context** for this repo. **Canonical agent rules:**[AGENTS.md](../AGENTS.md)at the repo root (structure, don’ts, “when adding”). This file duplicates stack/commands for Claude; on conflict, prefer **AGENTS.md** and the codebase.
3
+
**Claude Code context** for this repo. **Canonical agent rules:**[AGENTS.md](../AGENTS.md) (structure, don’ts, “when adding”, documentation map). This file adds stack/commands for Claude; on conflict, prefer **AGENTS.md** and the codebase. **Path-scoped rules:**[.claude/rules/](rules/) (`config`, `features`, `shared-components`, `shared-services`).
4
4
5
5
## Project Overview
6
6
@@ -16,7 +16,7 @@ Production-oriented React Native starter for mobile apps: feature-first architec
16
16
-**Backend/API:**`src/shared/services/api/`
17
17
-**Auth:** interceptors in shared API; session in `src/session/`
18
18
-**Testing:** Jest (react-native preset), react-test-renderer; `jest.config.js`, `jest.setup.js`
19
-
-**CI/CD:** GitHub Actions — `.github/workflows/android-ci.yml`, `.github/workflows/ios-ci.yml`; Fastlane mentioned in docs for Play/TestFlight
19
+
-**CI/CD:** GitHub Actions — `.github/workflows/ci.yml` (PR checks), `.github/workflows/android-ci.yml`, `.github/workflows/ios-ci.yml` (manual); Fastlane optional — not in this template (add under `fastlane/`for store releases; see [docs/OPERATIONS.md](../docs/OPERATIONS.md#github-actions))
Feature services live under `src/features/<feature>/services/`; features own their screens, components, hooks, models (Zod + mappers), and api (query keys).
44
+
Feature code lives under `src/features/<feature>/`: `screens/`, `components/`, `hooks/`, **`types/`** (interfaces + type aliases), `services/` (Zod + mappers + service modules), `api/keys.ts`, `navigation/param-list.ts`.
44
45
45
46
## Key Commands
46
47
@@ -49,7 +50,7 @@ Feature services live under `src/features/<feature>/services/`; features own the
49
50
npm install
50
51
51
52
# Metro
52
-
npm run start
53
+
npm start
53
54
54
55
# Run
55
56
npm run ios
@@ -86,7 +87,7 @@ npm run android:build:release # Android
86
87
-**Component pattern:** Functional components only; no class components.
87
88
-**File naming:** PascalCase for components (e.g. `ScreenWrapper.tsx`); camelCase or kebab for utils/services (e.g. `navigation-helpers.ts`, `auth.service.ts`).
88
89
-**Exports:** Named exports for components/hooks; screens follow existing files.
89
-
-**API layer:**`src/shared/services/api/`; feature services in `features/<name>/services/`; Zod validation.
90
+
-**API layer:**`src/shared/services/api/`; feature services in `features/<name>/services/`; domain types in `features/<name>/types/`; Zod validation.
Same **topic-to-doc** matrix as [AGENTS.md#documentation-map](../AGENTS.md#documentation-map) (canonical). Root [README.md](../README.md) is the only project README; do not duplicate the full table there.
description: Use this agent to create, improve, and maintain project documentation. Specializes in technical writing, documentation standards, and generating documentation from code. Examples: <example>Context: A user wants to add documentation to a new feature. user: 'Please help me document this new API endpoint.' assistant: 'I will use the documentation-expert to generate clear and concise documentation for your API.' <commentary>The documentation-expert is the right choice for creating high-quality technical documentation.</commentary></example> <example>Context: The project's documentation is outdated. user: 'Can you help me update our README file?' assistant: 'I'll use the documentation-expert to review and update the README with the latest information.' <commentary>The documentation-expert can help improve existing documentation.</commentary></example>
4
+
color: cyan
5
+
---
6
+
7
+
You are a Documentation Expert specializing in technical writing, documentation standards, and developer experience. Your role is to create, improve, and maintain clear, concise, and comprehensive documentation for software projects.
8
+
9
+
**This repository:** Canonical doc matrix is [AGENTS.md](../../AGENTS.md#documentation-map). The root [README.md](../../README.md) is the only project README—do not reintroduce a second index under `docs/`. Path-scoped authoring rules live in [.claude/rules/](../rules/).
10
+
11
+
Your core expertise areas:
12
+
-**Technical Writing**: Writing clear and easy-to-understand explanations of complex technical concepts.
13
+
-**Documentation Standards**: Applying documentation standards and best practices, such as the "Diátaxis" framework or "Docs as Code".
14
+
-**API Documentation**: Generating and maintaining API documentation using standards like OpenAPI/Swagger.
15
+
-**Code Documentation**: Writing meaningful code comments and generating documentation from them using tools like JSDoc, Sphinx, or Doxygen.
16
+
-**User Guides and Tutorials**: Creating user-friendly guides and tutorials to help users get started with the project.
17
+
18
+
## When to Use This Agent
19
+
20
+
Use this agent for:
21
+
- Creating or updating project documentation (e.g., README, CONTRIBUTING, USAGE).
22
+
- Writing documentation for new features or APIs.
23
+
- Improving existing documentation for clarity and completeness.
24
+
- Generating documentation from code comments.
25
+
- Creating tutorials and user guides.
26
+
27
+
## Documentation Process
28
+
29
+
1.**Understand the audience**: Identify the target audience for the documentation (e.g., developers, end-users).
30
+
2.**Gather information**: Collect all the necessary information about the feature or project to be documented.
31
+
3.**Structure the documentation**: Organize the information in a logical and easy-to-follow structure.
32
+
4.**Write the content**: Write the documentation in a clear, concise, and professional style.
33
+
5.**Review and revise**: Review the documentation for accuracy, clarity, and completeness.
34
+
35
+
## Documentation Checklist
36
+
37
+
-[ ] Is the documentation clear and easy to understand?
38
+
-[ ] Is the documentation accurate and up-to-date?
39
+
-[ ] Is the documentation complete?
40
+
-[ ] Is the documentation well-structured and easy to navigate?
41
+
-[ ] Is the documentation free of grammatical errors and typos?
Copy file name to clipboardExpand all lines: .claude/rules/shared-services.md
+3-1Lines changed: 3 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,6 +2,8 @@
2
2
globs: src/shared/services/**
3
3
---
4
4
5
+
Global rules: [AGENTS.md](../../AGENTS.md). Claude stack summary: [CLAUDE.md](../CLAUDE.md).
6
+
5
7
# Rules — shared/services
6
8
7
9
Infrastructure-level data layer. Split into two sub-trees:
@@ -28,5 +30,5 @@ shared/services/
28
30
29
31
## Must not
30
32
- Do not import from `src/features/**` — this layer is feature-agnostic.
31
-
- Do not put business logic or domain models here. Domain logic belongs in `src/features/<name>/services/`.
33
+
- Do not put business logic or domain models here. Domain logic belongs in `src/features/<name>/services/`; domain **interfaces and type aliases** belong in `src/features/<name>/types/`.
32
34
- Do not use Zustand stores inside this layer — pass data up via return values or callbacks.
We pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
6
+
7
+
## Our standards
8
+
9
+
Examples of behavior that contributes to a positive environment:
10
+
11
+
- Using welcoming and inclusive language
12
+
- Being respectful of differing viewpoints and experiences
13
+
- Accepting constructive criticism gracefully
14
+
- Focusing on what is best for the community
15
+
16
+
Examples of unacceptable behavior:
17
+
18
+
- Harassment, trolling, or insulting comments
19
+
- Public or private harassment
20
+
- Publishing others’ private information without permission
21
+
22
+
## Enforcement
23
+
24
+
Project maintainers may remove, edit, or reject contributions that violate this code. Violations may result in a temporary or permanent ban from the project spaces.
25
+
26
+
Reports may be sent to the maintainers via GitHub (e.g. direct message or issue, per project preference). Replace this section with a dedicated contact if you run a public fork.
27
+
28
+
## Attribution
29
+
30
+
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 2.1.
0 commit comments