openSUSE / agama / 7461764413

72%

push

github

[web][doc] Change the typedoc output (#976)

In general, the Agama documentation start aging bad. It's either,
disperse in a bunch of files, outdated, incomplete, or sometimes even
wrong.

At the time of writing, using a static site generator like
[Docusaurus](https://docusaurus.io/) or
[Vitepress](https://vitepress.dev) look as good bet to start fixing
these problems by putting all the Agama information accessible in a kind
of website without too much effort.

In that context, with these tools in mind, this PR can be seen a
starting point for having a better output of autogenerated
documentation.

Next steps must include reviewing all the written documentation for
fixing and improving at the same time that `@category`, `@internal`, and
other [Typedoc tags](https://typedoc.org/guides/tags/) are used
correctly for an even better output.

1418 of 2158 branches covered (0.0%)

Branch coverage included in aggregate %.

15986 of 21068 relevant lines covered (75.88%)

22.31 hits per line