Skip to content

Overhaul Docs #829

@zschira

Description

@zschira

Overview

The only archiver docs we really have are in the README.md. This is not really sufficient for such a large project/core piece of infrastructure. There's also almost certainly a lot of information in here that is out of date and wrong.

This issue should probably follow #828 as we don't want to overhaul the docs immediately before major changes to the top level interface.

Tasks

  • Decide where docs should live/be published. We could create a wiki within the git repo, or use readthedocs or some other system
  • Develop skeleton for new docs
  • Review existing readme and move information that is still relevant to new docs as applicable
  • Ensure all out of date information is removed

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    Projects

    Status

    Icebox

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions