Skip to content

sugg: Ensure docs are current and complete by unifying with code #341

@planetf1

Description

@planetf1

Proposal: Unify Documentation and Code into Single Repository (Mintlify)

As a new contributor just getting started with Mellea, I noticed some places where the docs website has drifted from the code in this repo.

The Problem

Docs are maintained in a separate repo (generative-computing/docs), which creates friction that leads to the website falling behind.

Specific Examples :

Proposed Solution

Move to a Single Repo model (like AgentStack):

  1. Migrate Config: Move docs.json (renaming to mintlify.json) into mellea/docs/.
  2. Consolidate: Serve docs directly from the docs/ folder here.
  3. Update Dashboard: Point Mintlify to generative-computing/mellea.
  4. Archive: Deprecate the old docs repo.

Benefits

Note

  • Additional Repos: We do also have contribs/extras. We'd need to sync/copy content if we wanted to integrate in main repos. On balance I still think the proposal here makes sense as it focusses on the core - and we can revisit later if needed.

I'd be happy to help 🚀

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