Skip to content

Commit

Permalink
docs: migrate from api-documenter to typedoc (#488)
Browse files Browse the repository at this point in the history
  • Loading branch information
divdavem committed Dec 22, 2023
1 parent 226ac54 commit fa786e9
Show file tree
Hide file tree
Showing 12 changed files with 218 additions and 49 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ jobs:
- name: Updating API documentation in gh-pages branch
run: |
rm -rf *
cp -a ../apidoc/output/* .
cp -a ../apidoc/* .
git add .
git commit --allow-empty -a -m "Updating from ${{ github.sha }}"
git push origin gh-pages
Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
[![codecov](https://codecov.io/gh/AmadeusITGroup/kassette/branch/master/graph/badge.svg)](https://codecov.io/gh/AmadeusITGroup/kassette)

<p align="center">
<img src="doc/assets/images/kassette-logo.png" alt="kassette-logo" width="200px" height="90px"/>
<img src="https://raw.githubusercontent.com/AmadeusITGroup/kassette/master/doc/assets/images/kassette-logo.png" alt="kassette-logo" width="200px" height="90px"/>
<br>
<i>kassette is a development server, used mainly for testing, which proxies requests and
<br>is able to easily manage local mocks.</i>
Expand Down Expand Up @@ -46,7 +46,7 @@ With this configuration, input requests targeting URLs starting with `/api/` wil

Note that kassette can also be configured to run as a browser proxy, reading the target URL from the request, and intercepting HTTPS communications.

Check [_Getting started_](./doc/getting-started.md) to learn more.
Check [_Getting started_](https://github.com/AmadeusITGroup/kassette/blob/master/doc/getting-started.md) to learn more.

## Main features

Expand Down Expand Up @@ -85,8 +85,8 @@ If you want to install it locally though, you need to add one more step. You won

## User documentation

It is advised to start with the [_Getting started_](./doc/getting-started.md) article which describes a few practical usage examples, then check the [configuration guide](./doc/configuration.md) and the [API guide](./doc/api.md). The [API reference](https://amadeusitgroup.github.io/kassette/kassette.html) is also available.
It is advised to start with the [_Getting started_](https://github.com/AmadeusITGroup/kassette/blob/master/doc/getting-started.md) article which describes a few practical usage examples, then check the [configuration guide](https://github.com/AmadeusITGroup/kassette/blob/master/doc/configuration.md) and the [API guide](https://github.com/AmadeusITGroup/kassette/blob/master/doc/api.md). The [API reference](https://amadeusitgroup.github.io/kassette/) is also available.

## Developing / Contributing

See [developer guide](./DEVELOPER.md) for details.
See [developer guide](https://github.com/AmadeusITGroup/kassette/blob/master/DEVELOPER.md) for details.
214 changes: 180 additions & 34 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit fa786e9

Please sign in to comment.