Commit graph

87 commits

Author SHA1 Message Date
Kailash Nadh be4be729a9 Refactor and clean up API Markdown docs.
This has been pending for several years. Finally, managed to do with
GPT-4 "auto" cleaning language and other consistency issues.
90% GPT4, 10% manual hand-wringing.

GPT-4 prompt:
```
- Fix grammar, simplify language, and make language and terms consistent.
- Remove superfluous language, avoid unncessary "the"s etc.
- Change endpoint description in tables that list endpoints, change to terse imperative language.
- Parameter / field description in Parameter tables, don't be imperative or use active sentences. Only describe the parameter passively and tersely.
- Remove backticks from all headings and table values.
- Format markdown tables.
- Standardize "data type" columns values into number, string[], string, JSON.
- Remove the "parameter type" column from tables.
- Wrap ID parameters in URIs in braces. Eg: /lists/list_id to /lists/{list_id}
- Add a markdown line above every API path heading that begins with GET, POST, PUT, DELETE.
- Leave the lines starting with `#code-` untouched
- Do not add new sections, headings, or any new content. Only edit existing content as described above.
- Do not remove any sections or any existing content.
```
2023-11-10 22:30:14 +05:30
Kailash Nadh f8a55f84fa Fix mkdocs navbar shadow 2023-11-10 12:17:11 +05:30
Kailash Nadh f720e88b44 Refactor <hr> style in mkdocs template. 2023-11-10 09:03:47 +05:30
Kailash Nadh b29f565b68 Fix broken table in campaign doc. Closes #1585. 2023-11-09 16:48:45 +05:30
Kailash Nadh 3641f74c64 Add missing header field in campaign creation docs. Closes #1561. 2023-11-01 18:49:48 +05:30
MaximilianKohler fd05a6d17d
Update installation.md - add cd listmonk (#1576) 2023-10-31 11:04:38 +05:30
Heiko 7019f26280
Fix docs for public subscription api (#1522) 2023-09-12 21:32:23 +05:30
Kailash Nadh 2b95c88188
Add Postmark bounce webhook support (refactor #1385) (#1485)
Co-authored-by: Thomas Siebers <tom@tsiebers.de>
2023-08-31 21:27:34 +05:30
MaximilianKohler e5ac111747
Update installation.md - fly.io instructions not working (#1487) 2023-08-31 19:43:40 +05:30
MaximilianKohler 34d86fc387
Update installation.md (#1494)
Add note about docker version
2023-08-30 10:51:20 +05:30
Karan Sharma 5664e5cc9f
fix: replace docker-compose with docker compose (#1490)
Fixes https://github.com/knadh/listmonk/issues/1431
2023-08-28 20:13:03 +05:30
MaximilianKohler 16eeb9401e
added "tutorials" section and other minor edits (#1444) 2023-08-27 13:34:22 +05:30
MaximilianKohler 52a7298a9d
Update bounces.md (#1468) 2023-08-27 12:54:31 +05:30
Kailash Nadh 07a9632860 Update latest version on homepage. 2023-08-21 10:12:36 +05:30
MaximilianKohler e2f1313566
Update configuration.md (#1465) 2023-08-20 09:41:30 +05:30
MaximilianKohler fcdea6050e
Update bounces.md (#1466) 2023-08-20 09:41:13 +05:30
MaximilianKohler 2888dcdd45
Update upgrade.md (#1467) 2023-08-20 09:40:44 +05:30
Kailash Nadh 32b979eeb6 Update subscriber docs and add public subscription API. Closes #1449. 2023-08-13 18:48:24 +05:30
MaximilianKohler 2f07435816
Update bounces docs (#1445)
proper bullets
2023-08-13 15:48:39 +05:30
MaximilianKohler e258ffda38
Update configuration docs (#1446)
media uploads
2023-08-13 15:39:43 +05:30
Kailash Nadh f3e9b08026 Update release on website. 2023-08-11 00:24:52 +05:30
Felix Winterleitner b1fa28980e
update documentation for api/tx to include file attachments and multiple recipients (#1436) 2023-08-07 16:29:34 +05:30
Kailash Nadh 2bfbae74ab Update Postgres version in doc strings. 2023-07-27 23:45:39 +05:30
Koen Martens 329b645a3d
Add documentation for archive function. Closes #1396. (#1399) 2023-07-12 19:36:15 +05:30
Yatish Mehta 530165f5ee
Fix typos in comments (#1368)
Co-authored-by: Yatish Mehta <yatish@example.com>
2023-06-20 23:40:34 +05:30
Nils Jacobsen f577522fe1
Update inlang.config.js (#1359) 2023-06-03 18:22:13 +05:30
Rohan Shetty 63bc00d8e3
Fix issues in the Swagger collection (#1322). Closes #1321. 2023-05-24 10:44:41 +05:30
Rohan Shetty cbbbe402be
Fix missing fields in Swagger collection. Closes #1317. 2023-05-10 11:18:40 +05:30
Rohan Shetty 5a2627932d
Fix Swagger collection. Closes #1308. Closes #1313 (PR #1314) 2023-05-08 23:37:11 +05:30
Rohan Shetty e332622db9
Added remaining endpoints to the Swagger Collection (#1283)
* added swagger collection for APIs

* added remaining endpoints to the swagger collection
2023-04-25 22:17:43 +05:30
Kailash Nadh 9381e086a1 Link the Swagger pages on the API doc. 2023-04-11 21:51:30 +05:30
Kailash Nadh 7db3d7da0f Improve i18n editor.
- Add a one-click `download JSON` button.
- Add a `New language` button.

Add secondary editor InLang (remote service) to docs.

Closes #1266, #1267.
2023-04-06 11:57:57 +05:30
Kailash Nadh 71a9138b23 Add missing i18n languages to the editor 2023-04-06 11:29:58 +05:30
Marcin Kunert ad53632be4
Expanded docs about PUT /api/subscribers/:id (#1269)
I've expanded the docs a bit, related to #995
2023-04-02 20:40:38 +05:30
Kailash Nadh 5d3c10d198 Add new README to the docs directory. 2023-03-26 11:13:25 +05:30
Kailash Nadh 684c15a404
Add static Hugo website and mkdocs documentation to docs directory. (#1261)
This commit merges the static website and docs that was on
https://github.com/knadh/listmonk-site repository into the main
listmonk repo.

It also adds a GitHub Actions workflow to public the sites on GitHub
Pages instead of Netlify.
2023-03-26 00:51:20 +05:30
Rohan Shetty bf72154727
Add Swagger collection for APIs (#1253) 2023-03-25 11:35:15 +05:30