# Vendure Documentation

## Structure

- `docs/docs/reference/` - **AUTO-GENERATED** API reference documentation
- `docs/docs/guides/` - Manually written guides and tutorials
- `docs/docs/user-guide/` - Manually written end-user documentation

## Important: Generated vs Manual Content

### Generated Content (DO NOT EDIT DIRECTLY)

Everything in `docs/docs/reference/` is auto-generated by scripts:

- **TypeScript API docs**: Generated by `scripts/docs/generate-typescript-docs.ts`
- **GraphQL API docs**: Generated by `scripts/docs/generate-graphql-docs.ts`

These files are regenerated from source code and will be overwritten. To update them:
1. Modify the source code or JSDoc comments in the relevant package
2. Run `npm run docs:build` from the repo root

### Manual Content (CAN BE EDITED)

- `docs/docs/guides/` - Developer guides, tutorials, how-tos
- `docs/docs/user-guide/` - End-user documentation for the Admin UI

These files are written and maintained manually.