Documentation #18

Closed
opened 2023-09-05 20:56:40 +00:00 by jordan · 1 comment
Owner

There's a lot of documentation enhancements that need to be made. Among them:

  • Convert all man pages to markdown and place them in /docs.
  • Write a good README. Link to the docs from the README.
  • Remove the README.txt file.
  • Convert the changelog to CHANGELOG.md in repository root /docs.
  • Convert Cytoplasm's README to markdown
There's a lot of documentation enhancements that need to be made. Among them: - [x] Convert all `man` pages to markdown and place them in `/docs`. - [x] Write a good README. Link to the docs from the README. - [x] Remove the `README.txt` file. - [x] Convert the changelog to `CHANGELOG.md` in ~~repository root~~ `/docs`. - [x] Convert Cytoplasm's README to markdown
jordan added the
enhancement
label 2023-09-05 20:56:40 +00:00
jordan added this to the Gitea Migration project 2023-09-05 20:56:40 +00:00
jordan self-assigned this 2023-09-06 01:59:40 +00:00
jordan added a new dependency 2023-09-06 19:18:53 +00:00
jordan added a new dependency 2023-09-07 11:56:20 +00:00
jordan added a new dependency 2023-09-08 15:47:42 +00:00
Author
Owner

I converted all of the man pages I want to convert. I am leaving man pages for some development tools, like http, json, http-debug-server, and tt. These are command line utilities; their help is best viewed from the command line.

I converted all of the `man` pages I want to convert. I am leaving `man` pages for some development tools, like `http`, `json`, `http-debug-server`, and `tt`. These are command line utilities; their help is best viewed from the command line.
Sign in to join this conversation.
No milestone
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Blocks
#30 Website Redesign}
Telodendria/Telodendria
Depends on
#19 Use Makefiles
Telodendria/Telodendria
#32 Porting Guidelines
Telodendria/Telodendria
Reference: Telodendria/Telodendria#18
No description provided.