[generate-docc-reference] [GSoC 2025] Separate DocC Pages for Each Command

オープン
  • 何か問題がありますか？
#752 コメント 1 件 リアクション 0 件 担当者 0 名 GitHub で見る

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

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

評価

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

調査の方向性

既存の generate-docc-reference プラグインと、メインコマンド用の記事を現在生成している仕組みから始めてください。構造を定義する前に issue #721 と #722 を読んでください。完了の条件は、コマンド、フラグ、オプション、引数それぞれに個別のページとディレクトリがあり、提案されているメタデータファイルとカテゴリ分けが用意されていることです。

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

説明

Description

We’ve recently integrated the generate-docc-reference plugin into the SwiftArgumentParser project. One of the key improvements outlined in our project goals is to refine this plugin, enabling it to generate separate documentation pages for each command and organize them into a well-structured set of files. For now the plugin only generates an article for the main command. As articles are considered good for communicating the general purpose and overview of the project, we should create seperate pages for each command to get low level on explanations and how things work.

Proposed Structure

We can follow the structure below in order to expand our documentation generation further.

Image
High Level Overview of the Structure

  • Separation of Command Documentation
    The documentation will be split into individual pages for each command, with each page covering the details of the command, its flags, options, and arguments. This will provide clear, in-depth explanations for every command, rather than a single generic overview.

  • Hierarchical File Structure
    We will adopt a folder-based structure where each command, flag, option, and argument has its own dedicated markdown file. If a command has subcommands, they will also be structured into their own folders and documented similarly, ensuring clarity for users with more complex command-line tools.

  • Metadata Categorization
    To maintain organization, metadata will be added to each markdown file, categorizing them as command, flag, option, or argument. This will help categorize the components and provide meaningful context for users when navigating the documentation.

  • Metadata Files
    Relevant JSON files, such as topics.json, will be included in the root directory to define the overall structure of the documentation catalog.

Next Steps
  1. Since the contribution guidelines encourage small improvements and changes, we can start by creating directories and separate files for each command.
  2. Then we can create documents for argument, options and flags, listing all related properties to the command.
  3. Next, we can proceed to add the root metadata files like topics.json for the documentation catalog.
  4. Finally, we can focus on structuring the metadata for the arguments, options, and flags for each command.
  5. Then we can get low level and design the structure of our documentation files by solving the mentioned issues below:
主要言語
Swift
スター
3.8k
フォーク
436
平均マージ
4日 11時間
マージ済み PR（30日）
2

環境構築

はじめの一歩

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

apple/swift-argument-parser のほかの issue

apple/swift-argument-parser の issue をすべて見る

似ている issue

Swift の issue をもっと見る

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

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