The example documentation is a hot mess

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

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

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

評価

難易度
3/5
見積もり時間
1〜2日
初心者へのやさしさ
45/100
issue の種類
ドキュメント
明瞭さ
説明が足りない
活発さ
活発
技術スタック
cpp
領域
documentation

調査の方向性

Run the project's Doxygen configuration to generate documentation for the examples and open the output to see the rendering problems. Locate the example source files and the Doxyfile in the repo to understand the current setup. Done when the generated example documentation is clean and readable.

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

説明

documentation

Just look at the output of the most recent doxygen for the examples. It looks like hell.

主要言語
C++
スター
18
フォーク
4
平均マージ
7時間 18分
マージ済み PR(30日)
26

環境構築

はじめの一歩

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

OpenCyphal/CETL のほかの issue

OpenCyphal/CETL の issue をすべて見る

似ている issue

C++ の issue をもっと見る

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

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