posit-dev / posit-dev/rsconnect-python
documentation for API workflow
オープン
まだ誰も着手していません。
- 主要言語
- Python
- スター
- 37
- フォーク
- 28
- 平均マージ
- 1日 3時間
- マージ済み PR（30日）
- 7
説明
With the removal of the API docs, it would be good for users to have some sort of documentation to show how to use rsconnect-python API in a narrative way.
More than happy to start a PR of a markdown/Quarto file for the bits that I tend to use a lot (RSConnectServer, deploy_python_fastapi, etc) to start this off! LMK what format is most useful to you all.
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
まず、RSConnectServer と deploy_python_fastapi の残りの API 使用エントリポイントを特定し、次に削除された API ドキュメントがどのように構成されていたかを確認します。一般的に使用されるワークフローと名前付き API を網羅する物語形式の Markdown または Quarto ドキュメントを作成します。削除された API ドキュメントがなくてもユーザーがそのワークフローに従える状態をもって完了とします。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- python
- 領域
- api, documentation
- issue の種類
- ドキュメント
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 35/100