Skip to content

Commit

Permalink
Add some developer-facing documentation (#69)
Browse files Browse the repository at this point in the history
Whenever I touch this project I don't remember how to perform the most
common tasks, I figured let's document them.
  • Loading branch information
jstasiak authored Jun 20, 2024
1 parent 1f55e8e commit 5eea157
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ This repo is a friendly fork of the excellent https://github.com/ferdikoomen/ope
generator to better fit our exact use case. Some of these changes we'll try to get merged into the upstream, but some are more of a specific
use case for us, hence the need for a fork. This code is used by https://github.com/lune-climate/lune-ts to generate the base models/services.

We have some [Developer documentation](docs/dev.md).

# Release process

Changes made to the library will only be picked up by `lune-ts` once a new version is released to npm.
Expand Down Expand Up @@ -78,6 +80,8 @@ $ openapi --help

# Documentation

For end-users:

- [Basic usage](docs/basic-usage.md)
- [OpenAPI object](docs/openapi-object.md)
- [Client instances](docs/client-instances.md) `--name`
Expand All @@ -89,6 +93,10 @@ $ openapi --help
- [Authorization](docs/authorization.md)
- [External references](docs/external-references.md)

For developers:

- [Developer documentation](docs/dev.md)

# Support

- [Babel support](docs/babel-support.md)
Expand Down
29 changes: 29 additions & 0 deletions docs/dev.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Developer documentation

This document is for the developers of this project, not for the users.

## Common commands

Install the dependencies:

```
npm install
```

Build the project (doesn't run the tests):

```
npm run build
```

Run the tests (we have to build in order for the current code to be used):

```
npm run build && npm run test
```

Update the test snapshots (we have to build in order for the current code to be used):

```
npm run build && npm run test -- -u
```

0 comments on commit 5eea157

Please sign in to comment.