summaryrefslogtreecommitdiff
path: root/doc/manual/index.md
blob: cb1cb0c5e109d39b0a13dc56ac2299cb16190e42 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
# User Manual

## Index 

1. [Installation](./installation.md)
2. [API Referrence](./API.md)
3. [Webhook](./webhook.md)
4. [RSS](./rss.md)
5. [Migration](./migration.md)

---

## Ask a question 

Feel free to email me: `hi@eltr.ac`. Ask me anything you are not sure about. Opening an issue to ask questions is also OK, but I might be slow to respond.

## Report a bug 

I don't care for issue templates. When [submitting a new issue](https://codeberg.org/eltrac/weepinbell/issues/new), all you need to do is try to get these information as clear as possible.

1. Versions 
    - Weepinbell version 
    - JDK version 
    - Operating system version
    - Browser version (if relevant)
2. Your configuration file (hide your secrets and keys)
3. What you did (How can we reproduce this bug?)
4. Logs
    - `docker logs` or `journalctl` or whatever you're using

## Suggest a Feature

Read about our [philosophy](../PHILOSOPHY.md) first and then open an issue.