Directly link to docs on the site
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 68/100
- Issue type
- Feature
- Clarity
- Mostly clear
- Activity status
- Quiet
- Tech stack
- typescript
- Domain
- documentation, web-dev
Research direction
Start by inspecting the website navigation and header for the existing GitHub link. Add direct links from clack.cc to the @clack/core and @clack/prompts documentation, then verify that both links appear as intended and open the referenced package READMEs.
Written by the indexing model from the issue text.
Description
👋 Hi! Recent convert to Clack here - love the package & a lot of its design decisions!
However, every time I want to read docs for it, I forget all previous knowledge other than its URL and go through this process:
- Visit
clack.cc - Re-scan the page for docs links
- Click the GitHub link
- Scroll down
- Click
@clack/prompts
Would you be up for me adding direct links to @clack/core & @clack/prompts to the website, to save steps 2-4?
Vague mockup proposal:
- Dominant language
- TypeScript
- Stars
- 13
- Forks
- 2
- PR merge metrics
- No merged PRs in 30d
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
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 bombshell-dev/clack.cc
-
Difficulty 5/5 Over a week Newbie friendliness 25/100
bombshell-dev/clack.cc#2 · 1 comment ·
All issues in bombshell-dev/clack.cc
Similar issues
-
bug
Difficulty 1/5 Under an hour Newbie friendliness 88/100
StabilityNexus/Fate-EVM-Frontend#153 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
code-yeongyu/oh-my-openagent#9039 ·
Maintainers usually reply within 1 day
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
Tencent/teamai-cli#862 ·
Maintainers usually reply within 1 day
-
bug good first issue hacktoberfest redis
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
libredb/libredb-studio#1164 ·
Maintainers usually reply within 1 day
-
flake
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
Maintainers usually reply within 1 day