knadh/listmonk
1
1
Fork 0
mirror of https://github.com/knadh/listmonk.git synced 2024-09-20 07:16:33 +08:00
Code Issues Packages Projects Releases Wiki Activity
listmonk/docs
History
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
..
docs Refactor and clean up API Markdown docs. 2023-11-10 22:30:14 +05:30
i18n Improve i18n editor. 2023-04-06 11:57:57 +05:30
site Update latest version on homepage. 2023-08-21 10:12:36 +05:30
swagger Add Postmark bounce webhook support (refactor #1385) (#1485) 2023-08-31 21:27:34 +05:30
README.md Add new README to the docs directory. 2023-03-26 11:13:25 +05:30

README.md

Static website and docs

This repository contains the source for the static website https://listmonk.app

  • The website is in site and is built with hugo (run hugo serve inside site to preview).

  • Documentation is in docs and is built with mkdocs (inside docs, run mkdocs serve to preview after running pip install -r requirements.txt)

  • i18n directory has the static UI for i18n translations: https://listmonk.app/i18n