Hacktoberfest 2026:维护者为十月标记出来的 issue,仍然开放、适合新手。 浏览 Hacktoberfest issue

docs: add a "Deliver" tab for publishers (publish, gateway, SDK, pricing)

未关闭
#335 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
4/5
预计耗时
3-5 天
新手友好度
55/100
Issue 类型
文档
描述清晰度
描述清楚
活跃度
活跃
技术栈
markdown, typescript

调研方向

Start with docs/docs.json for the navigation, lib/copy.ts and the FAQ for site links, then inspect the existing docs and sponsord guides in the decdn/decdn repository. Check the referenced issues and ADRs before writing claims, and mark unshipped steps as coming. Done means the Deliver tab covers publishing, gateway access, SDKs, pricing and sponsor downloads, with source links for claims and updated site links.

由索引模型根据 Issue 内容生成。

描述

documentation enhancement

Problem

docs.decdn.org has three tabs: Overview, Protocol, Run a node. The only guide is "run a node". A customer who wants to deliver content learns nothing from the site about how to publish, what it costs, which SDK to call, or how their users fetch.

The repo README (decdn/decdn) documents the publisher path as origin import, aws s3 sync, namespace create, assign, then an out-of-band vetting step. None of that is on the docs site, and it is a path the demand-side work replaces anyway.

Proposal

A fourth tab, Deliver, written for the publisher, not the operator:

  • Publish. The one-command path once it ships (https://github.com/decdn/decdn/issues/2591): decdn publish ./dir → https://<ns>.decdn.link/. Until then, the current four steps, written as a guide with the vetting step named honestly.
  • Gateway. The decdn.link URL surface (https://github.com/decdn/decdn/issues/2593): browser, curl, HF_ENDPOINT, torrent webseed, with one copy-pasteable example each. Until it ships, the sponsord installers (decdn.sh / decdn.ps1) are the zero-wallet path and belong here.
  • SDK. decdn-client for Rust embedders (docs.rs link, the open_progressive_pull loop in ten lines), and the sponsord HTTP API (sponsord-api OpenAPI) for everyone else.
  • Pricing. Per-MB settlement in USDC (ADR 003), the FeeRouter split (ADR 026 § FeeRouter split), what a pool deposit buys, and how a publisher funds one (https://github.com/decdn/decdn/issues/2594). Every number cites its ADR; nothing is estimated.
  • Sponsor downloads. Move or mirror the sponsord guides (docs/sponsord/ in decdn/decdn: operator, installer, integrator, security) so a publisher finds them from the site.

Nav entry in docs/docs.json between Protocol and Run a node. The website's own copy (lib/copy.ts, FAQ) gets a "Deliver" link to it.

Notes

  • Every protocol or economic claim cites decdn/adr/ with an absolute GitHub URL, per the workspace rule. Steps that do not exist yet are written as "coming" with the issue link, not as if they shipped.
  • Related: https://github.com/decdn/stats/issues/65 (the demand-side number the site will eventually quote).
主要语言
TypeScript
星标
3
派生
0
平均合并
6 小时 29 分钟
30 天内合并 PR
59

环境准备

这个项目没有提供开发容器、Dockerfile 或贡献指南,环境需要你自己搭建:先看它的 README,通用步骤见我们的新手贡献指南。

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

decdn/website 的其他 Issue

查看 decdn/website 的全部 Issue

相似的 Issue

更多 TypeScript Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。