Skip to content
Documentation: Scopes

Scopes

The first part of every item's name, and how to organise them.

From the Documentation in Ronne AI Marketplace 0.3.0.

What a scope is

A scope is the first part of every item's name, after the @. It groups related items and keeps names from clashing: @platform/code-reviewer and @mobile/code-reviewer are two different items.

@platform/code-reviewer
@platform/secure-coding
@data/sql-style

Who creates and uses them

  • Root creates scopes, with a description, under Admin › Scopes. When you create an item, the scope picker lists every scope and shows the chosen one's description.
  • Anyone may propose an item in any scope. Review is the gate, not the scope: nothing is published until a moderator or root approves it.
  • A scope doesn't give anyone extra rights over its items. An item's first author is shown as its owner, for information only.

Naming rules

Scopes and item names use lowercase letters, digits and hyphens, up to 64 characters, and don't start or end with a hyphen. A few scopes are reserved, such as admin, root and rmk.

An item's scope and name are fixed once it's published: a new name is a new item.

Ways to organise them

Any of these works; pick one and describe each scope so people know where things go.

  • By team: @platform, @mobile, @data. Each team keeps its own items together.
  • By domain: @security, @testing, @docs. People find items by what they're about.
  • Shared basics: one scope, such as @platform, for what everyone installs, alongside team or domain scopes.