# docs

The Encore documentation is no longer authored in this repo. It's published at
https://encore.dev/docs.

The one exception is `ts/runtime/`, which is left here: it's the Encore.ts
runtime API reference, generated by TypeDoc from `runtimes/js/encore.dev` so
that generation stays next to its source.

## Regenerating `ts/runtime/`

```
cd runtimes/js/encore.dev && npm run docs
```

Don't edit those files by hand — TypeDoc overwrites the directory on every run,
and CI regenerates them and fails if the committed output has drifted from the
source. Change the doc comments in `runtimes/js/encore.dev` instead, then
regenerate and commit the result.

## Feedback

Spotted something wrong or missing in the docs? Open an issue here on GitHub or
tell us on [Discord](https://encore.dev/discord) — we're glad to hear it.