reactjs / reactjs/react.dev

Documentation feedback

Open
#476 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
11.8k
Forks
7.9k
Avg merge
1d 11h
Merged PRs (30d)
11

Description

As with lots of repos and libs, I often find myself thinking about improvements to and gaps within docs as I'm stepping through. Sure, there's ways of capturing it; submitting an issue, Gitter, some doc platforms allow contribution links from within the docs themselves.

If possible, I think it would be a great feature to include (post-Github login) just-in-time commentary on docs that fits into a lightweight review/contrib workflow - I'm thinking it would look/function similarly to Medium.com's annotation feature.

Perhaps it's feature-worthy instead of "just file an issue" etc, because performing available contribution steps is certainly possible but it removes learners from their learning experience and train of thought (also busy experienced devs). Why not let learners stay on track while also making annotations that, if reviewed after learning (or when finding a mistake) can then also be shared/submitted into a usable workflow for maintainers?

This would also allow contributions in the form of documentation review that doesn't require living and breathing in the contrib ecosystem (just want to get learning, I'll contrib when I'm ready, but my feedback could still be valuable to others).

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

The issue names no files, tests, or entry points. Start by reviewing the existing react.dev contribution workflow and the requested post-GitHub-login annotation experience. Define the annotation and maintainer-review scope before implementation; the work is done when learners can submit useful documentation feedback without leaving the learning flow.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, react
Domain
documentation, frontend
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.