posit-dev / posit-dev/rsconnect-python
documentation for API workflow
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 37
- Forks
- 28
- Avg merge
- 1d 3h
- Merged PRs (30d)
- 7
Description
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.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the remaining API usage entry points for RSConnectServer and deploy_python_fastapi, then review how the removed API documentation was organized. Draft a narrative Markdown or Quarto document covering the commonly used workflow and named APIs; done means users can follow that workflow without the removed API docs.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100