RustPython / RustPython/rustpython.github.io

[RFC] Improve website https://rustpython.github.io/

Open
#62 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

content
Dominant language
HTML
Stars
14
Forks
22
PR merge metrics
No merged PRs in 30d

Description

I wanted to try running yt-dlp using RustPython.
So I headed to the homepage and saw some installation instructions. Lovely!

Except, now what?
There are only online demos after that and the documentation doesn't tell me anything.

The answer was to look at the GitHub Readme. It'd be lovely if the website had some more info, like
"Now you can run RustPython by entering rustpython into the shell. e.g. rustpython -m demo.py"

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by comparing the website homepage's installation section with the GitHub Readme and the existing online demos. Update the website with the missing information about running RustPython from a shell, including the example command shown in the issue; done means a user can proceed after installation without needing to consult the Readme.

Written by the indexing model from the issue text.

Assessment

Tech stack
html
Domain
documentation, web-dev
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.