Concrnt Squareのドキュメント修正案

[ouroboros723]

以前ConcrntFunコミュニティ上で提案した、ドキュメントの修正案(目次)を作成しましたので、提案としてこちらに公開します。

• はじめに
  • コンセプト
  • コンカレントの目指すゴール
  • アーキテクチャ
  • アイデンティティ
  • レポジトリ
  • オブジェクト
  • タイムライン
  • ポリシー
  • 他プロトコルとの比較
  • 開発史
• ユーザー
  • 新規登録
  • ログイン
    • マスターキーログイン
      • マスターキーでしかできないこと
    • サブキーログイン
    • QRコードログイン
  • ホームタイムライン
  • コミュニティ
    • 既存のコミュニティの探索
    • コミュニティ・アカウントの購読
    • コミュニティの作成
  • リストの作成
  • フォローとウォッチ
  • 投稿
    • 投稿先の指定
    • 絵文字の挿入とショートコード
    • メディアの挿入
    • 内容を隠す
    • ウィスパーモード
  • 設定
    • 一般
      • 開発者ツール
    • プロフィール
      • プロフィールの設定
      • バッジ
      • サブプロフィール
        • 投稿時のプロフィール切り替え
    • ID管理
      • アカウントエイリアス
      • ドメインの届けている情報
      • セッション情報(サブキーの管理)
      • アカウントの削除
    • テーマ
      • テーマのインストール
        • テーマコミュニティ
      • ThemeCreator
      • 自作テーマの共有
    • サウンド
    • 絵文字
      • 絵文字パッケージの追加
        • 絵文字パッケージコミュニティ
      • 絵文字パッケージの更新
      • 絵文字パッケージの共有
    • メディア
    • ActivityPub
      • Activity用ユーザーIDの登録
      • フォロー
      • 照会
    • ログインQR
    • データ管理
      • データのエクスポート
      • データのインポート
      • 他のサーバーへ引っ越し
      • 他のサーバーから引っ越し
• サーバー運営者
  • セットアップ
    • サーバー運営者の責任
    • Docker VS Kubernetes（どちらを選択するか？）
    • セットアップ手順 (Docker編)
    • セットアップ手順 (Kubernetes編)
  • メンテンナンス
    • アップデート手順 (Docker編)
    • アップデート手順 (Kubernetes編)
    • バックアップ (Docker編)
    • バックアップ (Kubernetes編)
  • conctl リファレンス
• 開発者
  • マイクロサービスアーキテクチャ
    • Concrntコア
      • ccapi
      • ccgateway
    • 公式提供モジュール
      • hyperproxy
      • mediaserver
      • search
      • ap-bridge
      • webfinger
    • モジュール間連携
      • Redisを使用する方法
      • REST APIを使用する方法
    • モジュールの公開方法
      • ghcr.io
  • Redis データフォーマット
  • REST APIリファレンス
  • 絵文字パックの作成
  • policyスキーマ
  • コントリビューションガイド
• アセット

上記の項目がドキュメントに含まれていれば、Concrntを触るにあたって必要な、基本的な情報が網羅できるのではないかと考えています。
また、”利用者” ”運営者” "開発者" にセクションを分けることで、それぞれの立場の人が必要な情報により素早くアクセスしやすくなるのではないかと考えました。

是非皆さんの意見をいただきたいです。よろしくお願い致します。

[totegamma]

ありがとうございます！
方針としてworldの細かい使い方はsquare側というよりはworld側にチュートリアルみたいな感じで置きたいな〜とは思いました！
バージョンアップ方法等はぜひ記載したいですね。
あとhyperproxyとかmediaserverとかは公式モジュールという言い方はできるだけ避けたいところです(あくまでも実装例で、選択肢の一つでしかないので)リファレンス実装みたいなところでしょうか。

[ouroboros723]

@totegamma
コメントありがとうございます。

方針としてworldの細かい使い方はsquare側というよりはworld側にチュートリアルみたいな感じで置きたいな〜とは思いました！

なるほどですね。

公式モジュールという言い方はできるだけ避けたいところです

なるほど💦
そうすると"リファレンスモジュール"という呼び方の方が的確でしょうか？

いただいたコメントをもとに案を修正しました。
よろしければご確認をお願いします 🙇

worldチュートリアル（に追加したい内容）

• 新規登録
• ログイン
  • マスターキーログイン
    • マスターキーでしかできないこと
  • サブキーログイン
  • QRコードログイン
• ホームタイムライン
• コミュニティ
  • 既存のコミュニティの探索
  • コミュニティ・アカウントの購読
  • コミュニティの作成
• リストの作成
• フォローとウォッチ
• 投稿
  • 投稿先の指定
  • 絵文字の挿入とショートコード
  • メディアの挿入
  • 内容を隠す
  • ウィスパーモード
• 設定
  • 一般
    • 開発者ツール
  • プロフィール
    • プロフィールの設定
    • バッジ
    • サブプロフィール
      • 投稿時のプロフィール切り替え
  • ID管理
    • アカウントエイリアス
    • ドメインの届けている情報
    • セッション情報(サブキーの管理)
    • アカウントの削除
  • テーマ
    • テーマのインストール
      • テーマコミュニティ
    • ThemeCreator
    • 自作テーマの共有
  • サウンド
  • 絵文字
    • 絵文字パッケージの追加
      • 絵文字パッケージコミュニティ
    • 絵文字パッケージの更新
    • 絵文字パッケージの共有
  • メディア
  • ActivityPub
    • Activity用ユーザーIDの登録
    • フォロー
    • 照会
  • ログインQR
  • データ管理
    • データのエクスポート
    • データのインポート
    • 他のサーバーへ引っ越し
    • 他のサーバーから引っ越し

Square

• はじめに
  • コンセプト
  • コンカレントの目指すゴール
  • アーキテクチャ
  • アイデンティティ
  • レポジトリ
  • オブジェクト
  • タイムライン
  • ポリシー
  • 他プロトコルとの比較
  • 開発史
• サーバー運営者
  • セットアップ
    • サーバー運営者の責任
    • Docker VS Kubernetes（どちらを選択するか？）
    • セットアップ手順 (Docker編)
    • セットアップ手順 (Kubernetes編)
  • メンテンナンス
    • アップデート手順 (Docker編)
    • アップデート手順 (Kubernetes編)
    • バックアップ (Docker編)
    • バックアップ (Kubernetes編)
  • conctl リファレンス
• 開発者
  • マイクロサービスアーキテクチャ
    • Concrntコア
      • ccapi
      • ccgateway
    • リファレンスモジュール(拡張機能)
      • hyperproxy
      • mediaserver
      • search
      • ap-bridge
      • webfinger
    • モジュール間連携
      • Redisを使用する方法
      • REST APIを使用する方法
    • モジュールの公開方法
      • ghcr.io
  • Redis データフォーマット
  • REST APIリファレンス
  • 絵文字パックの作成
  • policyスキーマ
  • コントリビューションガイド
• アセット