Schroedinger-Hat/ImageGoNord-Web

Optimize the documentation and the getting started guide

Open

#34 opened on Apr 14, 2021

View on GitHubContributor guide
 (11 comments) (0 reactions) (1 assignee)Vue (34 forks)auto 404
documentationgood first issue

Repository metrics

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

Description

  • getting started
  • how to install the pip package
  • show some code examples
  • api documentation to run on a private server
  • heroku api documentation
  • cli documentation
  • troubleshooting

Contributor guide

Research direction
Review the current documentation and identify gaps. Refer to the project's structure and usage examples to write clear instructions. Focus on the getting started guide, installation, code examples, API docs for private server and Heroku, CLI docs, and troubleshooting.
Tech stack
vuejavascript
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.
Half day
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
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80