> For the complete documentation index, see [llms.txt](https://docs.netmap.dev/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.netmap.dev/development/repository-structure.md).

# Repository Structure

This page describes the public source layout. Contributor local checkout folders, local branch directories, editor settings, and personal automation rules are outside the documentation scope.

Backend: `backend/app`.

Frontend: `frontend/src`.

Docker packaging: `docker`.

Hosted documentation: `documentation/`.

Project notes: `docs/`.

## Top-Level Folders

| Path             | Purpose                                                      |
| ---------------- | ------------------------------------------------------------ |
| `backend/`       | FastAPI backend, routes, schemas, models, services, tests    |
| `frontend/`      | React SPA, workspaces, shared components, hooks, styles      |
| `docker/`        | all-in-one Dockerfile, nginx template, entrypoint            |
| `documentation/` | VitePress documentation site                                 |
| `docs/`          | project architecture, design, planning, and maintainer notes |
| `scripts/`       | release and maintenance scripts                              |
| `assets/`        | screenshots and media used by the project                    |

## Documentation

The root `documentation/` directory contains the public documentation source and its VitePress configuration.

The `docs/` directory contains project notes that may be useful to contributors but are not the public documentation site.

## Contributor checkout

Create a GitHub fork and clone that fork into any working directory:

```bash
git clone https://github.com/YOUR_GITHUB_USERNAME/netmap.git
cd netmap
git remote add upstream https://github.com/xoriin/netmap.git
git fetch upstream
```

Run commands from the repository root unless a page says to enter `backend/`, `frontend/`, or `documentation/`. Continue with [Contributing Workflow](/development/contributing-workflow.md) to create the `test` branch and submit the change.

## Related Pages

* [Backend Development](/development/backend-development.md)
* [Frontend Development](/development/frontend-development.md)
* [Contributing Workflow](/development/contributing-workflow.md)


---

# 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://docs.netmap.dev/development/repository-structure.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.