Automagically add version for installs on docs based on latest Major
Open
Nobody has claimed this yet.
enhancement
- Dominant language
- JavaScript
- Stars
- 6
- Forks
- 4
- PR merge metrics
- No merged PRs in 30d
Description
Feature Proposal
Grab version from package.json env var and place into various docs pages.
Use the major version of the given library.
i.e. use pkg to grab the version of tailwind for example and set the install to show npm install tailwindcss@{MAJOR}
Related Context or Links
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 with package.json and inspect the documentation pages containing installation commands. Determine how the package version can be read and how the major version should be inserted into those docs. Done means the relevant install examples show the current library major version, including the tailwindcss example described in the issue.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100