Project

General

Profile

Feature #40

Move documentation to wiki

Added by koszko 11 months ago. Updated 10 months ago.

Status:
Closed
Priority:
High
Assignee:
Start date:
07/01/2021
Due date:
% Done:

100%

Estimated time:

History

#1

Updated by jahoti 11 months ago

There's no wiki to move documentation to yet (it seems you're the only one with the power to create one).

#2

Updated by jahoti 11 months ago

  • Status changed from New to In Progress
  • Assignee set to jahoti

Unless anybody else wants to take this task on, I'm happy to do so (having managed to create the wiki).

However, there is a critical decision to make first: do we want to use Textile or Markdown for the wiki? It is currently set to use Textile (Administration → Settings → Text Formatting); Markdown would seem a much better choice, both for its widespread familiarity and not insisting every paragraph start with "p. ". That said, it's not my decision to make singlehandedly, nor a setting I have the ability to change.

#3

Updated by koszko 11 months ago

Changed to Markdown as per your request

#4

Updated by jahoti 11 months ago

  • % Done changed from 0 to 90

(Thank you for switching it to Markdown!)

The documentation is now all on the wiki, with a slight re-organization purely to avoid h4 (it won't be too difficult to change this if closer adherence to doc.org is preferred). The only issue is a few references to the build system, which treat it as hypothetical; one is the article on the topic, the other the last paragraph in the article on code modularity. There are almost certainly also mistakes in changing from org-mode to markdown, albeit for obvious reasons none I can point to.

#5

Updated by jahoti 11 months ago

  • Status changed from In Progress to Feedback
#6

Updated by koszko 11 months ago

  • Status changed from Feedback to Closed

jahoti wrote:

The only issue is a few references to the build system, which treat it as hypothetical;

I think there might also be some other things that need updating, especially now, as I made some things show up in the popup. In the future I might have to force myself to always update documentation together with my branch. Anyway, this is beyond the scope of this issue (which I consider complete, btw).

Thank you very much for this work :) close adherence to doc.org is not necessary

#7

Updated by jahoti 10 months ago

  • % Done changed from 90 to 100

Also available in: Atom PDF