Decide what `v1.0.0` requires

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

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

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

評価

難易度
5/5
見積もり時間
1週間以上
初心者へのやさしさ
5/100
issue の種類
機能追加
明瞭さ
説明が足りない
活発さ
活発
技術スタック
git
領域
release

調査の方向性

This is a release-planning checklist for the owner, not a code change, so it is not a first task. Read docs/CONTEXT.md (the Conventions section on links to component pages) for background. The re-check commands in the issue show the current state of the links and page changes. Done means the owner has ticked or declined each item and planned the 1.0.0 release.

索引モデルが issue の本文から書いたものです。

説明

type:tech-debt
Description of Technical Debt

living-doc is at v0.1.0. Until v1.0.0 a minor may break and a patch never does. v1.0.0 comes when the owner
judges the product ready for users outside the owner's own projects; there is no fixed scope. Candidates to weigh:

  • GitHub Issues as a documentation source (epic)
  • Azure DevOps as a documentation source (epic)
  • PDF output (epic)
  • the security review
  • performance at volume
  • contract versioning with a compatibility interval (living-doc-utilities)
  • a first external user
  • links into component pages on tags. Today every link from living-doc to a page of a component stays on master
    while the ecosystem is under development (docs/CONTEXT.md § Conventions). The components link
    living-doc-utilities' rules on master while pinning a release, so a utilities page change ahead of the next
    minor makes a component's page link a rule its pinned version does not implement.
Impact of Technical Debt
  • None today; without a list, readiness is judged afresh each time.
Category

Other

Priority

Low - Nice to have

Proposed Solution

At each living-doc 0.x release the owner reviews this list, ticks or declines each item, and adds new ones. When every kept item is ticked, plan the 1.0.0 release.

Effort Estimate

Not applicable

Dependencies / Related

The three epics; the security, performance and contract-versioning issues.

Additional Context

Measured 2026-11-12 at living-doc 2df73dc. Re-check:

Links still on master in a component: git grep -c -E 'living-doc-utilities/(blob|tree)/master' -- '*.md'. Pages changed since a pinned utilities release: git diff --stat v<pinned> origin/master -- docs in living-doc-utilities.

主要言語
Python
スター
0
フォーク
0
平均マージ
6時間 14分
マージ済み PR(30日)
27

環境構築

はじめの一歩

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

AbsaOSS/living-doc のほかの issue

AbsaOSS/living-doc の issue をすべて見る

似ている issue

Python の issue をもっと見る

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

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