From 92963b34c9f438403c619f4808f17358ae344692 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?David=20D=C3=ADaz?= <1691872+dgdavid@users.noreply.github.com> Date: Sat, 20 Jan 2024 23:26:12 +0000 Subject: [PATCH] [web][doc] Change references to JSDoc (#1009) A few weeks ago, the [documentation output was reworked a bit](https://github.com/openSUSE/agama/pull/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. --- web/README.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/web/README.md b/web/README.md index 96dae571ed..d981a61d77 100644 --- a/web/README.md +++ b/web/README.md @@ -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 .