LoginRadius / LoginRadius/engineering-blog-samples

Create Readme for every directive

Open
#48 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Jupyter Notebook
Stars
248
Forks
369
PR merge metrics
No merged PRs in 30d

Description

1. Create the Readme file for every root directive
2. Add all demo in the Readme for better readability

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by listing the repository's root directive directories and reviewing the demo files in each one. Create a README for every root directive, include all relevant demos for readability, and verify that each directive has complete documentation.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, nodejs
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.