anikethsaha/create-web-app

Adding Docs

Open

#7 opened on May 28, 2019

View on GitHubContributor guide
 (1 comment) (0 reactions) (0 assignees)TypeScript (3 forks)auto 404
dependenciesdocsenhancementgood first issuehacktoberfesthelp wanted

Repository metrics

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

Description

Feature To add documentation creation library and writing docs for the package.

Library Suggestion

Our first Major release will be after completion of this feature.

updated

It would be helpful too if we get improvement on current docs that is on readme(s)

Contributor guide

Research direction
Evaluate documentation generation libraries such as Typedoc, Docsify, Docusaurus, and documentationjs. Choose one that best fits the project's needs and integrate it to generate documentation from TypeScript source code. Also improve existing README documentation.
Tech stack
typescript
Domain
documentationdeveloper experience
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
JavaScriptTypeScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70