Consider adding examples using SSH with GitHub
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 17
- Forks
- 20
- PR merge metrics
- No merged PRs in 30d
Description
On https://docs.pyscript.net/2024.5.2/developers/ under "Prepare your repository," all of the examples for how to add/manage remotes are for HTTPS.
Trying to use HTTPS with GitHub can be confusing, especially for beginners. Perhaps add examples for managing remotes via SSH?
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
Open the PyScript documentation page at https://docs.pyscript.net/2024.5.2/developers/ and start at the “Prepare your repository” section. Review the existing HTTPS examples for adding and managing remotes, then add corresponding SSH examples for GitHub. Done means beginners can see how to perform the same remote-management steps with SSH.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- git, github
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 55/100