Skip to content

Convert QuickDocs to use ExDoc #86

@martinsumner

Description

@martinsumner

To get QuickDocs up-and-running quickly, the initial version has been done using Just The Docs - https://just-the-docs.com/.

Ideally, we should move this to a documentation solution that sits within our own community e.g. ExDoc.

There were some potential issues which pushed the short-term answer to JTD:

  • As this is a pure "Pages" documentation, are we pushing against the grain in using ExDoc (i.e. in comparison to JTD).
  • The ability to add labels with regards to version information appears to be limited to function/module documentation?
    • Does this just need some html to be added in Pages?
  • Are admonition blocks limited to sections with H3/H4 headings?
  • There appears to be less possible simply through configuration with ExDoc (but this might just be a documentation issue).

There may be some advantages with ExDoc e.g. support for Tabsets. Also when we document Erlang/Elixir clients in future releases, having a consistent docs platform may be useful.

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