Hacktoberfest 2026:メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

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

オープン
#335 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
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時間 30分
マージ済み PR(30日)
66

環境構築

このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

decdn/website のほかの issue

decdn/website の issue をすべて見る

似ている issue

TypeScript の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。