crisishistory/HistoryAIToolkit

Improve "Getting Started" instructions

Open

#44 opened on Oct 4, 2023

View on GitHub
 (4 comments) (0 reactions) (0 assignees)Python (18 forks)github user discovery
documentationhacktoberfest-acceptedhelp wanted

Repository metrics

Stars
 (13 stars)
PR merge metrics
 (PR metrics pending)

Description

  • Move the getting started section from the readme into its own file in the docs folder
  • Link to the new getting started file in the docs folder once created, from other places that reference it:
  • Try them out and make corrections as needed

Contributor guide

Research direction
Move the 'Getting Started' section from README.md to a new file in docs/ (e.g., docs/getting started.md). Update all references: README.md, CONTRIBUTING.md, and the ReadTheDocs index page (docs/index.rst or similar). Verify links and test the instructions.
Tech stack
python
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitMarkdown
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85