Skip to content

Documentation tooling #5

@mansellan

Description

@mansellan

As we start to think about documentation, especially as it will be a community effort, one of the first questions to answer is: "What does the workflow for that look like?"

It would be hugely impractical to start writing raw HTML pages, we need a way of managing content. There's any number of ways of doing that, but which is best?

  • Doxygen?
  • DocFx?
  • MdBook?
  • Something else?

I would hope that source for documents could be stored in GitHub, along with some kind of spec for a table of contents and some kind of styling sheet. But what format should that be? Markdown? XML (please no...)? Something else?

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions