docs(site): clean up outdated README files#2178
Conversation
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]>
There was a problem hiding this comment.
💡 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 | |||
There was a problem hiding this comment.
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 👍 / 👎.
apps/playground/README.md
Outdated
| | 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>. |
There was a problem hiding this comment.
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 👍 / 👎.
Co-Authored-By: Claude Opus 4.6 (1M context) <[email protected]>
Deploying midscene with
|
| Latest commit: |
90da28a
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://4d84f66b.midscene.pages.dev |
| Branch Preview URL: | https://docs-cleanup-outdated-readme.midscene.pages.dev |
Co-Authored-By: Claude Opus 4.6 (1M context) <[email protected]>
Co-Authored-By: Claude Opus 4.6 (1M context) <[email protected]>
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]>
Summary
chrome-extension,recorder-form,report,playground/tests)computer,computer-playground,ios,recorder,playground) to link to the official documentation at https://midscenejs.comTest plan
🤖 Generated with Claude Code