partey_workadventure/docs/dev/README.md

# Developer documentation

This (work in progress) documentation provides a number of "how-to" guides explaining how to work on the WorkAdventure
code.

This documentation is targeted at developers looking to open Pull Requests on WorkAdventure.

If you "only" want to design dynamic maps, please refer instead to the [scripting API documentation](https://workadventu.re/map-building/scripting.md).

## Contributing

Check out the [contributing guide](../../CONTRIBUTING.md)

## Front documentation

- [How to add translations](how-to-translate.md)
- [How to add new functions in the scripting API](contributing-to-scripting-api.md)
- [About Wokas](wokas.md)

## Pusher documentation

The Pusher is exposing its HTTP API as "OpenAPI" endpoint.
You can browse this API at `http://pusher.workadventure.localhost/swagger-ui/`.
Developer documentation regarding scripting API This PR adds a first developer documentation regarding how to extend the scripting API. 2021-12-09 10:57:27 +01:00			`# Developer documentation`

			`This (work in progress) documentation provides a number of "how-to" guides explaining how to work on the WorkAdventure`
			`code.`

			`This documentation is targeted at developers looking to open Pull Requests on WorkAdventure.`

			`If you "only" want to design dynamic maps, please refer instead to the [scripting API documentation](https://workadventu.re/map-building/scripting.md).`

			`## Contributing`

			`Check out the [contributing guide](../../CONTRIBUTING.md)`

			`## Front documentation`

Add endpoints on pusher to resolve wokas 2022-02-17 15:02:11 +01:00			`- [How to add translations](how-to-translate.md)`
Developer documentation regarding scripting API This PR adds a first developer documentation regarding how to extend the scripting API. 2021-12-09 10:57:27 +01:00			`- [How to add new functions in the scripting API](contributing-to-scripting-api.md)`
Add endpoints on pusher to resolve wokas 2022-02-17 15:02:11 +01:00			`- [About Wokas](wokas.md)`
Adding OpenAPI documentation for the pusher. The pusher now exposes a "/openapi" endpoint and a "/swagger-ui/" endpoint. 2022-02-21 19:05:56 +01:00
			`## Pusher documentation`

			`The Pusher is exposing its HTTP API as "OpenAPI" endpoint.`
			You can browse this API at `http://pusher.workadventure.localhost/swagger-ui/`.