Automattic / Automattic/gravatar

Quick Editor: missing Github and documentation improvements

Open
#215 0 comments 0 reactions 0 assignees View on GitHub
[Feature] Quick Editor Documentation Enhance
Dominant language
TypeScript
Stars
361
Forks
125
PR merge metrics
No merged PRs in 30d

Description

Maybe the quick editor is missing a link in the package.json but on the NPM page for the Quick Editor package it doesn't show links to Github and documentation.

https://www.npmjs.com/package/@gravatar-com/quick-editor

Compare to:

https://www.npmjs.com/package/@gravatar-com/hovercards

As well as this the contributing and license links on NPM go to a 404.

Contributor guide

Open the contributing guide

Research direction

Inspect the Quick Editor package.json and compare its npm metadata with the hovercards package shown in the issue. Check the Github, documentation, contributing, and license links on the published Quick Editor npm page; done means all four links appear and resolve without 404 errors.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.