pyscript / pyscript/docs

Docs URLs: https://pyscript.github.io/docs/stable/...

Open
#70 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
17
Forks
20
PR merge metrics
No merged PRs in 30d

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:

Contributor guide

Open the contributing guide

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 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.

Assessment

Tech stack
python
Domain
documentation
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.