Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

agentOS registry markdown generation fails on artifact catalog data

Đang mở
  • Có gì không ổn?
#126 1 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
3/5
Thời gian dự kiến
1-2 ngày
Mức phù hợp với người mới
62/100
Loại issue
Lỗi
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
markdown, typescript
Lĩnh vực
documentation, tooling, web-dev

Hướng nghiên cứu

Start at src/data/registry-docs.ts (toIdent, softwareExample, usage around the stack trace) and the generated-entry type in src/data/registry.ts that still requires package. Swap in agentOS docs/registry.json as src/generated/artifacts/registry.json and run pnpm gen:markdown until it succeeds. Done when available software/browser cards no longer treat artifactName as an npm package, curated npm entries still render, and generation works with the current catalog.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

Description

The website's agentOS registry generator still expects an npm package field
for available software and browser entries. agentOS docs/registry.json now
supplies artifactName instead, following the move to immutable .aospkg
artifacts installed from URLs. When the website generator reads that catalog,
markdown generation fails before the synced docs can be built.

Steps to reproduce

  1. Use rivet-dev/website at 783204df and rivet-dev/agentos at c3698e6a.
  2. In the website checkout, run pnpm install --frozen-lockfile, pnpm assemble,
    and pnpm gen:markdown. With the website's committed older vendored registry,
    markdown generation succeeds (495 pages in this check).
  3. Replace only the generated website input
    src/generated/artifacts/registry.json with agentOS main's
    docs/registry.json.
  4. Run pnpm gen:markdown again.

Expected behavior

The website can generate registry documentation from the agentOS artifact
catalog. Available software and browser entries show installation guidance
appropriate to the artifact URL model, without assuming an npm package name.

Actual behavior

pnpm gen:markdown exits with:

TypeError: Cannot read properties of undefined (reading 'replace')
    at toIdent (src/data/registry-docs.ts:63)
    at softwareExample (src/data/registry-docs.ts:68)
    at usage (src/data/registry-docs.ts:157)

All 29 available entries (28 software and one browser) in the pinned
agentOS registry
have artifactName; none has package. The
website generator
routes both types through softwareExample(entry.package), which assumes an npm
package name. The generated-entry type in
src/data/registry.ts
also requires package for every available entry.

Impact

Once agentOS docs sync gets past its current missing-snippet validation failure,
the website build is expected to fail on this registry mismatch. This later
failure was reproduced locally using the two pinned upstream revisions; hosted
website CI has not reached it yet. Until the handoff and build pass, revised
agentOS docs cannot reach the live site through the normal sync path.

Possible fix

Update the website's generated registry entry type and rendering path to treat
artifactName as a logical key, not an npm package specifier. If the page shows
an artifact URL or runnable install example, resolve the key against the release
artifact manifest and use the supported agentOS software installation API. If
the manifest is not available to the website build, link to the software guide
without inventing an npm install or import snippet; coordinate with agentOS on
how a resolved URL should reach the website. Add a build/contract check with
agentOS registry data at the publishing boundary.

Acceptance criteria

  • Website markdown generation succeeds with current agentOS docs/registry.json.
  • Available software and browser cards no longer generate npm install or import
    instructions from artifactName alone.
  • Any displayed artifact URL is resolved from the release manifest, and setup
    guidance matches the supported agentOS software installation API.
  • Curated website registry entries that still legitimately use npm packages
    continue to render correctly.

Related: agentOS PR #2011
changed the catalog contract. The current
agentOS docs-sync run
fails earlier on missing snippets, so it does not demonstrate this website
generator failure.

Ngôn ngữ chính
TypeScript
Star
2
Fork
6
Merge trung bình
6 giờ 43 phút
Pull request đã merge (30 ngày)
56

Chuẩn bị môi trường

  • Có Dockerfile hoặc tệp Docker Compose
  • Không có mẫu pull request
  • Không có hướng dẫn đóng góp

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của rivet-dev/website

Tất cả issue của rivet-dev/website

Issue tương tự

Thêm issue về TypeScript

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.