Skip to content

[DevTools] Update ReadMe Docs For WebExtensions#138

Closed
everettbu wants to merge 1 commit into
mainfrom
devtools/correct-webextension-docs
Closed

[DevTools] Update ReadMe Docs For WebExtensions#138
everettbu wants to merge 1 commit into
mainfrom
devtools/correct-webextension-docs

Conversation

@everettbu

@everettbu everettbu commented Dec 12, 2025

Copy link
Copy Markdown

Mirror of facebook/react#34496
Original author: ospira


Summary

All three browser extension ReadMe files reference a path (shells/webextension) for common source code that I believe no longer exists.

Screenshot 2025-09-15 at 11 40 51 AM

I have a guess where the correct path now is, but given it should be easy for the maintainers to make this correction themselves (accurately and without guessing), I'm simply flagging it.

Thus for this PR to be completed it would need to replace the struck out characters with an updated, correct path. If I have made a mistake I apologize, but as you can see in that screenshot I could not find shells/webextension... I was able to find a top-level shells directory in the git history, but I must admit the git history is a little confusing, perhaps because this code used to live in a separate repo once upon a time?

In any event, it would be great if one of the maintainers could spend a few minutes confirm the issue and give a quick update for people coming to this fresh who want to dive into this particular aspect of the source code. Thanks for your time!

How did you test this change?

N/A

@greptile-apps

greptile-apps Bot commented Dec 12, 2025

Copy link
Copy Markdown

Greptile Overview

Greptile Summary

This PR attempts to fix outdated documentation that references a non-existent shells/webextension path, but the fix is incomplete. All three README files now strike through the incorrect path without providing the correct replacement, leaving the sentence "The source code for this extension has moved to shells/webextension" incomplete and unhelpful.

  • The correct path should be ../src (or packages/react-devtools-extensions/src from the repository root)
  • The shells/webextension path was correctly identified as outdated and no longer exists
  • However, the documentation now provides no guidance on where to find the source code

Confidence Score: 1/5

  • This PR makes the documentation worse by removing information without replacing it
  • The PR correctly identifies that shells/webextension is outdated, but only strikes through the path without providing the correct replacement. This leaves incomplete sentences that fail to inform users where the source code actually is located. The documentation needs to be updated with the correct path (../src) to be useful.
  • All three README files need the correct path provided instead of just striking through the old one

Important Files Changed

File Analysis

Filename Score Overview
packages/react-devtools-extensions/chrome/README.md 1/5 Strikes through incorrect path without providing replacement, leaving documentation incomplete
packages/react-devtools-extensions/edge/README.md 1/5 Strikes through incorrect path without providing replacement, leaving documentation incomplete
packages/react-devtools-extensions/firefox/README.md 1/5 Strikes through incorrect path without providing replacement, leaving documentation incomplete

@greptile-apps greptile-apps Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

3 files reviewed, 3 comments

Edit Code Review Agent Settings | Greptile

@@ -1,6 +1,6 @@
# The Chrome extension

The source code for this extension has moved to `shells/webextension`.
The source code for this extension has moved to ~~`shells/webextension`~~.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

logic: Incomplete documentation fix - the sentence now says "has moved to" but provides no destination. Should replace with the correct path.

Suggested change
The source code for this extension has moved to ~~`shells/webextension`~~.
The source code for this extension is in `../src`.
Prompt To Fix With AI
This is a comment left during a code review.
Path: packages/react-devtools-extensions/chrome/README.md
Line: 3:3

Comment:
**logic:** Incomplete documentation fix - the sentence now says "has moved to" but provides no destination. Should replace with the correct path.

```suggestion
The source code for this extension is in `../src`.
```

How can I resolve this? If you propose a fix, please make it concise.

@@ -1,6 +1,6 @@
# The Microsoft Edge extension

The source code for this extension has moved to `shells/webextension`.
The source code for this extension has moved to ~~`shells/webextension`~~.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

logic: Incomplete documentation fix - the sentence now says "has moved to" but provides no destination. Should replace with the correct path.

Suggested change
The source code for this extension has moved to ~~`shells/webextension`~~.
The source code for this extension is in `../src`.
Prompt To Fix With AI
This is a comment left during a code review.
Path: packages/react-devtools-extensions/edge/README.md
Line: 3:3

Comment:
**logic:** Incomplete documentation fix - the sentence now says "has moved to" but provides no destination. Should replace with the correct path.

```suggestion
The source code for this extension is in `../src`.
```

How can I resolve this? If you propose a fix, please make it concise.

@@ -1,6 +1,6 @@
# The Firefox extension

The source code for this extension has moved to `shells/webextension`.
The source code for this extension has moved to ~~`shells/webextension`~~.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

logic: Incomplete documentation fix - the sentence now says "has moved to" but provides no destination. Should replace with the correct path.

Suggested change
The source code for this extension has moved to ~~`shells/webextension`~~.
The source code for this extension is in `../src`.
Prompt To Fix With AI
This is a comment left during a code review.
Path: packages/react-devtools-extensions/firefox/README.md
Line: 3:3

Comment:
**logic:** Incomplete documentation fix - the sentence now says "has moved to" but provides no destination. Should replace with the correct path.

```suggestion
The source code for this extension is in `../src`.
```

How can I resolve this? If you propose a fix, please make it concise.

@everettbu everettbu added the Resolution: Stale Automatically closed due to inactivity label Dec 14, 2025
@github-actions

Copy link
Copy Markdown

Closing this pull request after a prolonged period of inactivity. If this issue is still present in the latest release, please ask for this pull request to be reopened. Thank you!

@github-actions github-actions Bot closed this Dec 21, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CLA Signed Resolution: Stale Automatically closed due to inactivity

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants