> For the complete documentation index, see [llms.txt](https://affine.gitbook.io/affine/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://affine.gitbook.io/affine/developer-docs/working-with-our-code.md).

# Working with our code

To help you get started here are some quick tips and info.

## Quick overview

The basic directory structure conventions in this repository are described here.

* Generic functional components (e.g. atomic UI components) are placed in `libs/components/common`.
  * Components within common are not allowed to import other components except utils and dependencies.
  * Common components can dependent on each other.
* Components containing business logic are placed in `libs/components`. The editor and draw prefixes are used to distinguish them.
* Data source components are placed in `libs/datasource`, including API requests, schemas, etc.

## Useful scripts

Some commonly used commands defined in package.json are listed here.

```
# Create react dependency library
pnpm run add:library

# Create react components
pnpm run add:components

# Create a data source
pnpm run add:datasource

# Run unit tests
pnpm test

# Compile or test or lint specific component
pnpm build|test|lint ${project name from workspace.json}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://affine.gitbook.io/affine/developer-docs/working-with-our-code.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.