Skip to content

Public documentation for OSS adoption #6

Description

@aktasbatuhan

The README is currently the entire public doc surface (design docs are deliberately local-only). For OSS adoption the project needs public documentation that explains the concepts, not just the commands.

What's needed

  • Restructure README: product first (quickstart in <5 minutes: import → curate → experiment → gate), benchmark-engine content moved down or out.
  • Public concept docs (docs/ on the repo, written fresh for public consumption): the sealed-partition firewall, pre-declared gate rules, earned-trust judging, money-safety, the optimize-proposes/gate-decides loop.
  • A worked example with a small bundled dataset so git clone → verdict works without Langfuse credentials.
  • LICENSE + CONTRIBUTING before the repo flips public.

Note: the "no md except README on remote" rule was for private planning docs; public-facing docs written for users are a different category — confirm scope before pushing.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions