Skip to content

Clarify the difference between Core and Signal ML in the docs #8

Description

@Permea-lab-admin

Goal

Help newcomers understand what belongs in Permea Core versus Permea Signal ML.

Suggested scope

  • Add a short note to README.md or an appropriate docs page.
  • Explain that Core holds shared specifications, governance, and benchmark contracts.
  • Explain that Signal ML holds the initial runnable ML workflow and evidence package.

Acceptance criteria

  • The distinction is clear in 1-2 short paragraphs.
  • The note links to the Signal ML repository if appropriate.
  • The change does not move scope between repositories.

Contributor note

This is a beginner-friendly documentation issue.

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

    documentationImprovements or additions to documentationgood first issueGood for newcomershelp wantedExtra attention is needed

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions