[CONC-571] Rework documentation storage/process Created: 2021-11-15 Updated: 2022-07-01 |
|
| Status: | Open |
| Project: | MariaDB Connector/C |
| Component/s: | Documentation |
| Affects Version/s: | None |
| Fix Version/s: | 3.3 |
| Type: | Task | Priority: | Major |
| Reporter: | Sergei Golubchik | Assignee: | Georg Richter |
| Resolution: | Unresolved | Votes: | 0 |
| Labels: | None | ||
| Description |
|
C/C documentation consists of API pages (mysql_real_connect, etc) and non-API pages ("Building and Installing", "Compatibility", etc). API pages directly correspond to man pages that are included in C/C source and binary packages. Currently, the primary source of C/C documentation is github wiki. Periodically Georg clones the wiki repo, runs pandoc to convert .md files into .3 manpages and checks them into C/C repository. Drawbacks:
If using an online-editable wiki is not a goal, we can move documentation to read-only github pages, as:
or
|