Skip to content

Commit

Permalink
[web][doc] Change references to JSDoc (#1009)
Browse files Browse the repository at this point in the history
A few weeks ago, the [documentation output was reworked a
bit](#976) to be ready for a near
future in which all the project documentation could be "managed" by a
static site generator. These adjustments implied a few changes that were
not reflected in the README file.
  • Loading branch information
dgdavid authored Jan 20, 2024
1 parent d516f74 commit 92963b3
Showing 1 changed file with 7 additions and 6 deletions.
13 changes: 7 additions & 6 deletions web/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,15 +81,16 @@ switcher is displayed only in local installation because it cannot work in
remote connection. This option will force displaying it even in a remote
connection.

## JSDoc Documentation
## TypeDoc Documentation

This project uses [TypeDoc](https://typedoc.org/) to generate the API documentation. The `jsdoc`
task generates the documentation to the `jsout.out` directory. If you need to adjust any TypeDoc
option, please check the `typedocOptions` key in the `tsconfig.js` file.
This project uses [TypeDoc](https://typedoc.org/) to generate the API documentation. The `typedoc`
task generates the documentation to the `typedoc.out` directory. If you need to adjust any TypeDoc
option, please check the [`typedoc.json` file](./typedoc.json).

```
npm run jsdoc
xdg-open jsdoc.out/index.html
npm run typedoc
xdg-open typedoc.out/client/index.html
xdg-open typedoc.out/components/index.html
```

GitHub Actions will automatically publish the result to <https://agama-frontend.surge.sh/>.
Expand Down

0 comments on commit 92963b3

Please sign in to comment.