Docs URLs: https://pyscript.github.io/docs/stable/...
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 48/100
- Issue type
- Feature
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- python
- Domain
- documentation
Research direction
Start by tracing how the documentation site currently handles version-specific URLs, using the 2024.2.1 and 2024.3.1 paths in the issue as examples. Compare that behavior with the requested stable path; done means stable links resolve to the current documentation without breaking versioned links.
Written by the indexing model from the issue text.
Description
The URL https://pyscript.github.io/docs/2024.2.1/user-guide/first-steps locks on a particular version which is often useful.
The URL https://pyscript.github.io/docs/2024.3.1/user-guide/first-steps locks on a particular version which is often useful.
However, sometimes when documenting solutions it is helpful to point to the current docs which will change over time. In this latter case, a URL like https://pyscript.github.io/docs/stable/user-guide/first-steps (stable) can also be quite useful.
This happens with:
- https://pyodide.org/en/stable/console.html # Currently Py3.11
- https://pyodide.org/en/latest/console.html # Currently Py3.12
- https://docs.djangoproject.com/en/4.2/faq/install/#what-python-version-can-i-use-with-django # Currently Dj4.2
- https://docs.djangoproject.com/en/stable/faq/install/#what-python-version-can-i-use-with-django # Currently Dj5.0
- https://docs.djangoproject.com/en/dev/faq/install/#what-python-version-can-i-use-with-django # Currently Dj5.1
- Dominant language
- Python
- Stars
- 17
- Forks
- 20
- PR merge metrics
- No merged PRs in 30d
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.
More from pyscript/docs
-
Difficulty 1/5 Under an hour Newbie friendliness 65/100
-
Difficulty 1/5 Under an hour Newbie friendliness 72/100
-
Difficulty 1/5 Under an hour Newbie friendliness 68/100
-
Difficulty 4/5 3-5 days Newbie friendliness 32/100
-
Difficulty 4/5 3-5 days Newbie friendliness 30/100
Similar issues
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 90/100
learningequality/ricecooker#747 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
BSData/horus-heresy-3rd-edition#3171 ·
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
run-llama/llama_index#23199 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
KhronosGroup/glTF-Blender-IO#2769 ·