cutenode / cutenode/good-first-issue

Add dedicated documentation site for Good First Issue CLI

Open
#1,078 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
832
Forks
236
PR merge metrics
No merged PRs in 30d

Description

I noticed the current documentation lives entirely in the README, which can be limiting for new users trying to onboard quickly.
I built a dedicated Docusaurus-based documentation site that covers:

- Quickstart guide
- Command reference
- Automation and scripting
- Contributing guide
- Troubleshooting

You can find the site here: https://good-first-issue-docs.vercel.app/

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the current README and the linked Docusaurus site at https://good-first-issue-docs.vercel.app/. Compare the proposed quickstart, command reference, automation, contributing, and troubleshooting content with the repository’s existing documentation, then clarify how the site should be incorporated before defining completion.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.