Skip to content

docs: improve README documentation - #10

Merged
jevin98 merged 1 commit into
mainfrom
codex/update-readme-docs
May 14, 2026
Merged

docs: improve README documentation#10
jevin98 merged 1 commit into
mainfrom
codex/update-readme-docs

Conversation

@jevin98

Copy link
Copy Markdown
Owner

What changed

  • Rewrote the English README to better explain CSS-Diff's purpose, strengths, features, installation, usage, development, build commands, tech stack, inspiration, and license.
  • Added a Simplified Chinese README with matching structure and reciprocal language links.
  • Added README guidance to AGENTS.md so future README generation keeps all language versions included and synchronized.

Why

The previous README only had a short description and minimal usage notes, so it did not clearly communicate the extension's value for frontend debugging or its core workflow.

Impact

Users and contributors get a clearer project overview in both English and Simplified Chinese, with accurate documentation for the current DevTools comparison behavior.

Validation

  • pnpm install --frozen-lockfile
  • pnpm exec eslint . --fix
  • git diff --check
  • pnpm compile

@jevin98
jevin98 merged commit 31628e7 into mainMay 14, 2026

@chatgpt-codex-connectorchatgpt-codex-connectorBot 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.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit:807f111f1b

ℹ️ 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".

Comment threadREADME.zh-CN.md
> [!WARNING]
> CSS-Diff 目前暂未上架浏览器扩展商店。

从 [Releases](https://github.com/Jevin0/css-diff-devtools/releases) 下载打包后的 zip 文件,然后在浏览器扩展程序页面中手动安装或加载。

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Document unpacking the release zip before loading

In the newly added Chinese README, users are told to download the packaged zip and then manually install/load it from the extensions page, but Chrome/Edge's unpacked-extension flow cannot load the .zip artifact directly; it needs to be extracted first and the output directory selected with "Load unpacked". Chinese users following these install steps will be blocked before they can try the extension, so this should explicitly mention unzipping or provide browser-specific package instructions.

Useful? React with 👍 / 👎.

@jevin98
jevin98 deleted the codex/update-readme-docs branch May 15, 2026 03:51
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant

@jevin98