# {{projectName}} — docs

Generated documentation for your SpecVerse project lives here.

## Layout

```
docs/
├── README.md            # this file
├── api/                 # generated API docs (npm run gen:docs)
├── diagrams/            # generated Mermaid diagrams (npm run gen:diagrams)
└── guides/              # hand-written guides — yours to maintain
```

## Generating content

```bash
npm run gen:docs          # writes API docs into api/
npm run gen:diagrams      # writes ER / lifecycle / architecture diagrams into diagrams/
```

Both commands are derived from `specs/main.specly`, so re-run them
whenever you change the spec.

## Where to find the SpecVerse language reference

The SpecVerse language schema and authoring guide are maintained in
the main project, not in your project. See the
[SpecVerse User Guide](https://github.com/SpecVerse/specverse-self/blob/main/docs/guides/SPECVERSE-USER-GUIDE.md).