Question: organization of documentation
まだ誰も着手していません。
評価
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 初心者へのやさしさ
- 25/100
- issue の種類
- ドキュメント
- 明瞭さ
- 説明が足りない
- 活発さ
- 停滞
- 技術スタック
- javascript
調査の方向性
この 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 を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
orientechnologies/orientdb-docs のほかの issue
-
難易度 1/5 1〜3時間 初心者へのやさしさ 88/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 48/100
-
難易度 1/5 1時間未満 初心者へのやさしさ 50/100
-
難易度 3/5 1〜2日 初心者へのやさしさ 25/100
-
難易度 4/5 3〜5日 初心者へのやさしさ 25/100
orientechnologies/orientdb-docs#387 · コメント 1 件 ·
orientechnologies/orientdb-docs の issue をすべて見る
似ている issue
-
難易度 1/5 1時間未満 初心者へのやさしさ 85/100
-
難易度 1/5 1時間未満 初心者へのやさしさ 90/100
ethereum/execution-apis#1017 ·
メンテナーはふだん 3 日以内に返信
-
[Docs] CONTRIBUTING points the Backend Remake milestone at a branch that does not exist対応中かも @franpts2 が今日担当しました。 オープンdocs
難易度 1/5 1時間未満 初心者へのやさしさ 90/100
メンテナーはふだん 3 日以内に返信
-
postgresql-rules / queue-rules: implicit KEY SHARE before a parent key update, and job self-overlapオープン
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
jonathanong/no-mistakes#3879 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
pearu/agent-sandbox#451 ·
メンテナーはふだん 1 日以内に返信