Convert top level docs to Markdown

XMLWordPrintableJSON

    • Type: Task
    • Resolution: Fixed
    • Priority: Unknown
    • 3.4
    • Affects Version/s: None
    • Component/s: None
    • None
    • None
    • None
    • None
    • None
    • None
    • None

      Context

      Markdown is easier to write and is interoperable with more tools. We can use pandoc to convert the files.

      brew install pandoc
      pandoc -f rst -t markdown CONTRIBUTING.rst > CONTRIBUTING.md
      

      Definition of done

      Top level RST files are converted to MD.

      Pitfalls

      Ensure that no information is lost and that the docs render properly on GitHub.

              Assignee:
              Steve Silvester
              Reporter:
              Steve Silvester
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Created:
                Updated:
                Resolved: