VladPolskiy/mediacms-user-docs
1
0
Fork 0
mirror of https://github.com/mediacms-io/mediacms.git synced 2025-07-28 23:23:09 +00:00
Code Issues Packages Projects Releases Wiki Activity

documentation improvements (#261)

Browse Source
This commit is contained in:
Markos Gogoulos
2021-08-01 19:47:35 +03:00
committed by GitHub
parent 16e2c32d17
commit c27e3caff6
4 changed files with 10 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/developers_docs.md
View File

@ -3,14 +3,20 @@
## Table of contents
- [System architecture](#system-architecture)
- [API documentation](#api-documentation)
- [How to contribute](#how-to-contribute)
- [Working with Docker tips](#working-with-docker-tips)
- [How video is transcoded](#how-video-is-transcoded)
## How to contribute
Before you send a PR, make sure your code is properly formatted. For that, use `pre-commit install` to install a pre-commit hook and run `pre-commit run --all` and fix everything before you commit. This pre-commit will check for your code lint everytime you commit a code.
Checkout the [Code of conduct page](../CODE_OF_CONDUCT.md) if you want to contribute to this repository
## System architecture
## API documentation
API is documented using Swagger - checkout ot http://your_installation/swagger
API is documented using Swagger - checkout ot http://your_installation/swagger - example https://demo.mediacms.io/swagger/
This page allows you to login to perform authenticated actions - it will also use your session if logged in.