Skip to content

Import project wiki into docs/ with triage inventory#3037

Merged
znz merged 167 commits into
rurema:masterfrom
znz:docs/import-wiki
Jul 9, 2026
Merged

Import project wiki into docs/ with triage inventory#3037
znz merged 167 commits into
rurema:masterfrom
znz:docs/import-wiki

Conversation

@znz

@znz znz commented Jul 9, 2026

Copy link
Copy Markdown
Member

概要

GitHub wiki の全40ページを docs/ 配下に取り込みます。wiki は編集がレビューを通らず、本体の変更(今回の Markdown 移行など)とドキュメントの更新が構造的にズレるため、リポジトリ内で PR 管理できるようにするのが目的です。

  • subtree マージで wiki の全履歴(2013年以降・165コミット)を保持しています。wiki リポジトリの履歴をパス書き換え(docs/ プレフィクス付与)した上で --allow-unrelated-histories マージしているので、git log docs/Tutorial.md などページ単位の履歴がそのまま引けます
  • ページ内容は取り込み時点の wiki のまま一切変更していません(docs/README.md の新設のみ)

棚卸し一覧(docs/README.md)

全40ページを分類し、処理区分(維持・部分更新・書き直し・統合・bitclust へ移動・アーカイブ・削除)と理由を付けた一覧を docs/README.md に追加しました。主な内訳:

  • 執筆ガイド10ページ: 記法まわりは全編 RRD 前提のため、MARKUP_SPEC.md ベースの書き直しが必要(ReferenceManualFormatDigest, ClassReferenceManualFormat, HowToWriteMethodEntry, Tutorial 等)
  • 参加ガイド: ML(消滅済み)前提の HowToJoin は GitHub ベースに書き直し、HowToContribute/HowToReport は CONTRIBUTING.md へ統合
  • ツール文書2ページ(BitClust, BitClustDatabase): rurema/bitclust の doc/ へ移動
  • 歴史文書8ページ(Phase1〜3 の計画・旧体制の手順): docs/archive/ へ凍結
  • 削除候補: 空ページ3つ(ProjectGoal, Committers, ReleaseProcess)、HowToInstallRubys 系3つ(2017年の rbenv/Windows 手順)、SitePolicy

このPRではまだ削除・移動・書き直しは行いません。一覧の合意後に別PRで実施します(wiki リンク [[PageName]] 約100箇所の相対リンク変換も棚卸し確定後)。

補足

  • wiki 側はマージ後も当面そのまま残し、各ページを新 URL への案内スタブに置き換えたのち、周知期間を経て無効化する想定です
  • Communication-and-knowledge-sharing に esa の招待 URL が記載されています(wiki でも公開状態でした)。取り込みを機に無効化・差し替えの検討をお願いします

🤖 Generated with Claude Code

tbpgr and others added 19 commits November 2, 2018 06:02
Merge the rurema/doctree wiki (github.com/rurema/doctree/wiki) into the
main repository under docs/, keeping the full wiki history (165 commits
since 2013) via a path-rewritten unrelated-histories merge, so that
project documentation can be reviewed and updated through pull requests
alongside the content it describes.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Categorize all 40 imported wiki pages (keep / update / rewrite / merge /
move to bitclust / archive / delete) with rationale, and outline the
follow-up steps: link conversion, wiki stubbing, and eventual wiki
shutdown. Many pages still describe the pre-migration RRD notation and
the defunct mailing-list-based workflow, so this inventory is the basis
for bringing them up to date.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@znz znz merged commit 901e566 into rurema:master Jul 9, 2026
1 of 3 checks passed
@znz znz deleted the docs/import-wiki branch July 9, 2026 05:33
znz added a commit to znz/bitclust that referenced this pull request Jul 9, 2026
The doctree wiki is being folded into the doctree repository's docs/
tree (rurema/doctree#3037); its two tool-focused pages belong here
instead. Import them as doc/usage.md (the BitClust page) and
doc/database.md (the BitClustDatabase page), converting wiki links to
repository links.

Content is otherwise kept as imported, with a provenance note on each
page; the usage page's update examples now show the post-migration
--markdowntree form first, and searchpage was added to the subcommand
list. A deeper freshness pass over the remaining command examples is
still pending.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
znz added a commit that referenced this pull request Jul 9, 2026
Per the inventory agreed in #3037 (docs/README.md):

- Delete empty or obsolete pages: ProjectGoal, Committers, ReleaseProcess,
  SitePolicy, and the three HowToInstallRubys pages
- Move historical records to docs/archive/ (frozen, with a README):
  Phase1-3 working schemes, Phase3ReviewProcess1, ProjectTimeLine,
  WorkingProcess, MaintenancePhase, DischargingProcess, MailingList,
  ReleasePackageHowTo
- Remove BitClust and BitClustDatabase, which move to the bitclust
  repository's doc/ tree (see the companion bitclust PR)
- Update the inventory in docs/README.md to reflect what was executed

No page contents are modified; rewrites and link conversion follow in a
separate PR.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
znz added a commit that referenced this pull request Jul 9, 2026
The wiki content moved into docs/ (#3037, #3039, #3040) and the wiki
pages are now redirect stubs, so link to docs/ directly.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
znz added a commit to rurema/bitclust that referenced this pull request Jul 11, 2026
wiki からの移設時 (rurema/doctree#3037) に「順次更新」とした鮮度確認を
実施する:

- リリース済み gem は Markdown 移行前のものである旨の注意を追加。
  現行ソース (manual/) のビルドは Git リポジトリ版を使う
- setup が凍結された旧 refm ツリーから構築する現状を明記
- htmlfile の例を実在するパスに直し、Markdown ソース未対応の注記を追加
- 存在しない info を削除し、epub と server を追加 (server は --help の
  一覧からも漏れていたので追加)
- 消滅した ML (fdiary.net) へのリンクを外し、1.9 時代のコマンド例を更新
- 壊れていた dl/dd タグを修正、rrd2md をツール一覧に追加

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.