Skip to content
This repository was archived by the owner on Jul 28, 2024. It is now read-only.
This repository was archived by the owner on Jul 28, 2024. It is now read-only.

Merge the docs repo into this main one #1113

@borekb

Description

@borekb

We currently manage the docs via a separate repo and should consider merging it into this main one, for these reasons:

  1. Documentation is as an integral part of the project and a feature should not be finished until documentation is written for it. The current repo structure doesn't reflect this well (we often write documentation way after the main feature is finished & merged).
  2. There would be a single contribution / review process.
  3. Long-running branches (3.x, 4.x etc.) would be used naturally for documentation as well.

Points against it:

  • We'd need to work out how to integrate this with our docs versioning ("version toggles" instead of branches).
  • It might feel easier to contribute to a small, focused repo.
    • Not sure if this is a real downside, those who'd contribute would probably be fine with both options.
  • Images: in a separate repo, it's not a big deal to have a folder like images. In this main repo, we want to watch out for any large binary files.
    • Images are aways a PITA. We should ideally cloud-host them.

Examples of project that have documentation inside the main repo:

Examples of project that have documentation as a separate repo:


🏁 Resolved by #1218

Metadata

Metadata

Assignees

Labels

noteworthySignificant issue or PR, to be highlighted in release notesscope: docsMarkdown documentation, public docs, READMEstaskDEPRECATED. This was used for non-code issues but just leave it out.

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions