docs(registry): update README to reflect JSON entry schema

[amondnet]

Summary

The README's Registry section described the old Markdown+YAML-frontmatter format. The implementation has since migrated to a Nuxt Content v3 type: 'data' collection backed by .json files and restructured the schema around the Entry → Package → Source hierarchy (ADR-0001). The docs were stale and misleading for contributors.

Changes

• File format: .md with YAML frontmatter → .json (Nuxt Content v3 type: 'data' collection)
• Schema restructured: flat aliases/strategies → Entry → Package → Source hierarchy per ADR-0001
• Source-type reference table added: npm, github, web, llms-txt with required/optional fields
• Monorepo example added: @mastra/core and @mastra/memory showing multiple packages in one entry
• Field renames: strategies[].source → sources[].type, docsPath → path, top-level aliases → per-package aliases
• Contributing section updated to point at registryEntrySchema in packages/schema/src/registry.ts and call out validation invariants (duplicate aliases, duplicate package names, slug collisions)

Test plan

• Render README on GitHub and verify code blocks display correctly
• Confirm all internal links (ADR-0001, packages/schema/src/registry.ts) resolve
• Spot-check that the JSON examples match the actual schema in packages/schema/src/registry.ts

---

Summary by cubic

Update the Registry docs in README to the JSON-based schema and Entry → Package → Source structure, replacing the old Markdown + YAML frontmatter format. Adds a source-type reference, a monorepo example (@mastra/core, @mastra/memory), field rename notes, updated contributing guidance pointing to validation in packages/schema/src/registry.ts, and syncs the Next.js example tags (adds vercel) to match the real entry.

^{Written for commit f1c7345. Summary will update on new commits.}

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

[cloudflare-workers-and-pages]

Deploying ask-registry with    Cloudflare Pages

Latest commit:	f1c7345
Status:	✅  Deploy successful!
Preview URL:	https://33d8e733.ask-registry.pages.dev
Branch Preview URL:	https://amondnet-readme-registry.ask-registry.pages.dev

View logs

[cubic-dev-ai]

No issues found across 1 file

_{Auto-approved: Documentation-only update to the README to reflect existing architectural changes (ADR-0001) and registry schema migration.}

Architecture diagram

sequenceDiagram
    participant Contributor
    participant FS as Registry Storage (JSON)
    participant Schema as Schema Validator
    participant Nuxt as Nuxt Content v3 (Data)
    participant Client as ASK CLI / App
    participant Providers as External (npm/GitHub/Web)

    Note over Contributor, FS: NEW: Entry definition process
    Contributor->>FS: Create/Update <owner>/<repo>.json
    
    Note over FS, Schema: Validation at Build/Runtime
    FS->>Schema: NEW: Validate Entry -> Package -> Source hierarchy
    Schema->>Schema: Check invariants (duplicate aliases, slugs, or package names)
    
    Note over Client, Nuxt: Data Retrieval
    Client->>Nuxt: Query documentation config for package alias
    Nuxt->>FS: NEW: Read type: 'data' collection
    FS-->>Nuxt: JSON Object
    Nuxt-->>Client: Resolved Package Entry (ordered sources)

    Note over Client, Providers: CHANGED: Source Resolution Flow
    loop For each source in sources[]
        Client->>Client: Identify source type (npm, github, web, llms-txt)
        Client->>Providers: Attempt fetch using type-specific fields
        alt Success
            Providers-->>Client: Documentation content
            Note over Client: Resolution Complete
        else Failure / Fallback
            Providers-->>Client: Error
            Note over Client: Try next source in priority list
        end
    end

Loading

[cubic-dev-ai]

0 issues found across 1 file (changes from recent commits).

_{Auto-approved: Documentation-only update to synchronize the README with the current JSON-based registry schema and reflect the Entry-Package-Source hierarchy.}