Design and prototype a consistent offline documentation snapshot contract
メンテナーはふだん 1 日以内に返信
まだ誰も着手していません。
評価
調査の方向性
Read #77 and #78 first, then inspect wavedoc/, internal/document/repository.go, and internal/web/handler/documents.go. Prototype the snapshot contract with a synthetic fixture covering interrupted downloads, revision changes, removed paths, and corrupt content. Done means a wire-format decision, documented consistency and retention rules, and small follow-up implementation tasks.
索引モデルが issue の本文から書いたものです。
説明
Roadmap: #76
Problem
The public API provides locale lists and individual documents, with no atomic offline-package contract. A client downloading multiple files across a server redeploy can otherwise mix revisions.
Scope
Specify and prototype a public documentation snapshot/export contract: stable revision identity, a manifest of paths/locales and content digests, retrieval consistency, size limits, and a clear response when a referenced snapshot is no longer available. Reuse embedded documentation; do not invent document bodies.
Done
- Define how one manifest binds all files to a single published revision.
- Specify translation/English fallback membership and Wave/Whale separation.
- Demonstrate interrupted downloads, changed deployment revisions, removed paths, and corrupt content using a synthetic fixture/prototype.
- Define retention, cache validation, and bounded generation costs; compare an export artifact with live API retrieval.
- Produce the wire-format decision and small follow-up implementation tasks before shipping a new endpoint.
Start: wavedoc/, internal/document/repository.go, internal/web/handler/documents.go. This issue owns the consistency protocol; device cache implementation is a separate roadmap task.
Prerequisites: #77, #78.
- 主要言語
- Go
- スター
- 1
- フォーク
- 7
- 平均マージ
- 5時間 55分
- マージ済み PR（30日）
- 20
環境構築
このプロジェクトの環境構築ファイルはまだ確認していません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
wavefnd/wave-platform のほかの issue
-
bug difficulty: beginner documentation good first issue help wanted localization
難易度 2/5 1〜3時間 初心者へのやさしさ 88/100
wavefnd/wave-platform#139 ·
メンテナーはふだん 1 日以内に返信
-
bug difficulty: beginner documentation good first issue help wanted localization
難易度 2/5 半日 初心者へのやさしさ 88/100
wavefnd/wave-platform#137 ·
メンテナーはふだん 1 日以内に返信
-
bug difficulty: beginner documentation good first issue help wanted localization
難易度 2/5 1〜3時間 初心者へのやさしさ 90/100
wavefnd/wave-platform#136 ·
メンテナーはふだん 1 日以内に返信
-
bug difficulty: beginner documentation good first issue help wanted localization
難易度 1/5 1時間未満 初心者へのやさしさ 94/100
wavefnd/wave-platform#135 ·
メンテナーはふだん 1 日以内に返信
-
bug difficulty: beginner frontend good first issue help wanted seo
難易度 2/5 1〜3時間 初心者へのやさしさ 88/100
wavefnd/wave-platform#70 ·
メンテナーはふだん 1 日以内に返信
wavefnd/wave-platform の issue をすべて見る
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
メンテナーはふだん 1 日以内に返信
-
status: ready for dev
難易度 1/5 1〜3時間 初心者へのやさしさ 92/100
hyperledger-labs/fabric-smart-client#2004 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 84/100
メンテナーはふだん 1 日以内に返信
-
bug
難易度 2/5 1〜3時間 初心者へのやさしさ 84/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
apache/datasketches-go#189 ·
メンテナーはふだん 1 日以内に返信