Skip to content

Topics for Discussion

uvtc edited this page Jan 30, 2013 · 6 revisions

Context (Static or no?)

...

Types

...

All the type-related stuffs (objects, classes, "everything is an object", etc.)

...

Parser (regex based or no?)

...

Upgrade from POD to something else?

Consider using Markdown. Rationale:

  • numerous existing implementations (Pandoc supports very nice extensions, is fast, well-maintained, mature, and is already written)
  • everyone already knows it (github, readmes, stackoverflow, reddit, etc.), or can learn it in 2 minutes
  • easy to read and write in plain text form (it's always good to make docs easier for authors to write and maintain)
  • looks good in plain text form
  • doesn't require any special syntax-highlighting
  • already using it here in Moe Faq.md, GitGuide.md, README.md, STATUS.md, and this wiki.

Incidentally, I note that Rust is using Pandoc for all their docs (not only for standalone docs; source code comments (in .rs files) are markdown-formatted as well, and they look nice :) ).

Clone this wiki locally