Skip to content

Suggested doc: Documentation home best practices #93

Open
@nate-double-u

Description

@nate-double-u

Where should documentation be housed in reference to a project's code repository?

  1. Documentation should be separate from the code, preferably in it's own website repository. Avoid duplication, source of truth for documentation is the website
  2. Documentation should be stored in the primary code repo, closest to the system being documented. Monorepo-style tools/organization can be used to generate a website from there
  3. Other(?)

I think that the TechDocs team tends towards option a., but each project is unique and other options are valid. I think we should put together a document that outlines our arguments for and against different strategies so we can refer to it as we're helping projects make decisions around how to setup their docs repositories.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to the TechDocs documentatione2-daysEffort: < 5 days

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions