Skip to content

docs(site): clean up outdated README files#2178

Merged
quanru merged 5 commits intomainfrom
docs/cleanup-outdated-readmes
Mar 19, 2026
Merged

docs(site): clean up outdated README files#2178
quanru merged 5 commits intomainfrom
docs/cleanup-outdated-readmes

Conversation

@quanru
Copy link
Collaborator

@quanru quanru commented Mar 19, 2026

Summary

  • Remove stale auto-generated READMEs from internal apps (chrome-extension, recorder-form, report, playground/tests)
  • Simplify published npm package READMEs (computer, computer-playground, ios, recorder, playground) to link to the official documentation at https://midscenejs.com
  • Total: 6 files deleted, 5 files simplified (-1482 lines)

Test plan

  • Docs-only change, no code affected
  • Verify npm packages still have README with links to official docs

🤖 Generated with Claude Code

Remove stale auto-generated READMEs from internal apps and simplify
published package READMEs to point to the official documentation site.

Co-Authored-By: Claude Opus 4.6 (1M context) <[email protected]>
Copy link

@chatgpt-codex-connector chatgpt-codex-connector bot left a comment

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 8406fe5ddc

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

@@ -1,141 +0,0 @@
# Midscene Chrome DevTools

Choose a reason for hiding this comment

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

P2 Badge Keep the Chrome extension README until CONTRIBUTING stops linking it

CONTRIBUTING.md:385 still sends contributors to ./apps/chrome-extension/README.md for the detailed extension instructions. Deleting this file turns that step in the extension install/package workflow into a dead local link, so anyone following the contributor guide loses the promised documentation unless the link is updated in the same change.

Useful? React with 👍 / 👎.

| History | Persistent | Persistent | Non-persistent |
| Target | Any Web Page | Current Tab | Android Devices |
| Context Preview | Optional | Yes | No | No newline at end of file
See <https://midscenejs.com/playground.html>.

Choose a reason for hiding this comment

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

P2 Badge Point the playground README at an actual docs route

This README now consists only of https://midscenejs.com/playground.html, but there is no matching playground.mdx page or /playground entry in apps/site/docs/{en,zh} or apps/site/rspress.config.ts. Because the README no longer contains any fallback instructions, readers of apps/playground are left with a broken docs link instead of setup guidance.

Useful? React with 👍 / 👎.

@cloudflare-workers-and-pages
Copy link

cloudflare-workers-and-pages bot commented Mar 19, 2026

Deploying midscene with  Cloudflare Pages  Cloudflare Pages

Latest commit: 90da28a
Status: ✅  Deploy successful!
Preview URL: https://4d84f66b.midscene.pages.dev
Branch Preview URL: https://docs-cleanup-outdated-readme.midscene.pages.dev

View logs

quanru and others added 3 commits March 19, 2026 11:12
Update android, android-playground, cli, and web-integration READMEs
to link to their specific documentation pages instead of the generic
homepage.

Co-Authored-By: Claude Opus 4.6 (1M context) <[email protected]>
@quanru quanru merged commit 7483f5f into main Mar 19, 2026
10 checks passed
@quanru quanru deleted the docs/cleanup-outdated-readmes branch March 19, 2026 09:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants