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

Aperta
  • Qualcosa non va?
#752 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 3 giorni

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
25/100
Tipo di issue
Funzionalità
Chiarezza
Da chiarire
Stato di attività
Ferma
Stack tecnologico
swift
Ambito
cli, documentation

Direzione di ricerca

Inizia con il plugin generate-docc-reference esistente e con la sua generazione attuale di un articolo per il comando principale. Leggi le issue #721 e #722 prima di definire la struttura; il lavoro è completo quando esistono pagine e directory separate per comandi, flag, opzioni e argomenti, insieme ai file di metadati e alla categorizzazione proposti.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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:
Lingua principale
Swift
Stelle
3.8k
Fork
436
Merge medio
4g 11h
PR unite (30g)
2

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di apple/swift-argument-parser

Tutte le issue di apple/swift-argument-parser

Issue simili

Altre issue su Swift

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.