Question: organization of documentation

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

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

評価

難易度
5/5
見積もり時間
1週間以上
初心者へのやさしさ
25/100
issue の種類
ドキュメント
明瞭さ
説明が足りない
活発さ
停滞
技術スタック
javascript
領域
documentation

調査の方向性

この issue では orientjs のドキュメント、ドライバーのドキュメント、JSDoc スタイルのコメントが挙げられていますが、ファイルやテストは指定されていません。まずこれらのドキュメント領域を特定し、リポジトリ内にありバージョン管理されるドキュメントと生成されたシグネチャが対象に含まれるかを明確にしてください。完了の条件は、合意されたドキュメント構成と生成アプローチがあることです。

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

説明

Is there a reason why the docs are store separately from the codebase?

Would you consider storing the docs for each repo with the code itself? At least for the drivers? It would be easier to tell what code works for what version then. In particular, this is currently a bit difficult when using the orientjs docs.

It would also be nice to have jsdoc style comments that could auto-generate docs. Then it would be easier to see function signatures etc.

If this is something you'd like to do I would be happy to help/contribute

主要言語
CSS
スター
59
フォーク
164
PR マージ指標
30日以内にマージされた PR はありません

環境構築

このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。

はじめの一歩

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

orientechnologies/orientdb-docs のほかの issue

orientechnologies/orientdb-docs の issue をすべて見る

似ている issue

Documentation の issue をもっと見る

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

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