Skip to content

更新多处官方文档入口与版本说明#1045

Open
QinIndexCode wants to merge 1 commit into
jaywcjlove:mainfrom
QinIndexCode:docs/refresh-official-references
Open

更新多处官方文档入口与版本说明#1045
QinIndexCode wants to merge 1 commit into
jaywcjlove:mainfrom
QinIndexCode:docs/refresh-official-references

Conversation

@QinIndexCode

@QinIndexCode QinIndexCode commented Jun 17, 2026

Copy link
Copy Markdown
Contributor

Summary

  • 更新 FastAPI、Flutter、Docker Compose、jq、Less、Scala、Emoji、Gemini CLI、Ruby、React 共 10 处文档的官方入口或版本说明
  • 调整 Docker Compose、FastAPI、Flutter 等示例,使安装、版本检查和参考链接说明更清晰
  • 补充 FastAPI release notes、Docker Compose standalone install、Ruby 3.4 API、React StrictMode、Flutter SDK archive 等官方参考

References

  • FastAPI official docs and release notes
  • Flutter install docs and SDK archive
  • Docker Compose plugin install docs and releases
  • jq official site and manual
  • Less.js official docs
  • Scala official docs and API
  • Unicode Emoji v17 charts
  • Google Gemini CLI repository and Google Cloud docs
  • Ruby official docs and Ruby 3.4 API
  • React StrictMode docs

Validation

  • npx --yes markdownlint-cli docs\fastapi.md docs\flutter.md docs\docker-compose.md docs\jq.md docs\lessjs.md docs\scala.md docs\emoji.md docs\gemini-cli.md docs\ruby.md docs\react.md
  • git diff --check
  • npm.cmd run build

Comment thread docs/docker-compose.md

```sh
docker compose version
# Docker Compose version v2.17.3

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

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

@QinIndexCode 这里是输出结果

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

已恢复这段 docker compose version 的输出结果,保留为示例输出格式。

Comment thread docs/docker-compose.md

docker version
# Client: Docker Engine - Community
# Cloud integration: v1.0.31

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

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

@QinIndexCode 这里是我真实的输出结果

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

已恢复 docker versionCloud integrationVersionAPI version 这些真实输出行。

Comment thread docs/docker-compose.md Outdated
```sh
curl -SL https://github.com/docker/compose/releases/download/v2.27.0/docker-compose-linux-x86_64 -o /usr/local/bin/docker-compose
DOCKER_CONFIG=${DOCKER_CONFIG:-$HOME/.docker}
mkdir -p $DOCKER_CONFIG/cli-plugins

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

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

@QinIndexCode 需要简单安装并加以说明

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

已改为简单的 standalone 安装示例,并补充说明该方式用于兼容旧项目中的 docker-compose 命令,版本号可按 Compose releases 替换。

Comment thread docs/docker-compose.md Outdated

```sh
$ sudo ln -s /usr/local/bin/docker-compose /usr/bin/docker-compose
$ sudo ln -s $DOCKER_CONFIG/cli-plugins/docker-compose /usr/local/bin/docker-compose

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

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

默认 $DOCKER_CONFIG 这个环境变量是空的

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

已去掉依赖 $DOCKER_CONFIG 的写法,软链接示例恢复为 /usr/local/bin/docker-compose/usr/bin/docker-compose

Comment thread docs/fastapi.md Outdated
```

Python: `3.9.5` FastAPI: `0.103.1`
建议使用当前受支持的 Python 版本,并通过 `python -m pip show fastapi` 确认本地安装版本。

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

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

@QinIndexCode 我希望描述简单,如果是命令可以放到命令中如

$ uvicorn main:app --reload
$ python -m pip show fastapi #确认本地安装版本

尽量简单

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

已按建议简化,把 python -m pip show fastapi 放进命令块,并移除了单独描述。

Comment thread docs/flutter.md Outdated
```bash
$ cd ~/development
$ unzip ~/Downloads/flutter_macos_3.22.2-stable.zip
$ unzip ~/Downloads/flutter_macos_*_stable.zip

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

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

@QinIndexCode 希望的是固定版本安装

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

已改回固定版本安装示例,更新为当前官方 archive 中的 stable 版本 3.44.0,并保留 SDK archive 作为其他版本入口。

Comment thread docs/lessjs.md

- [CSS 备忘清单](./css.md) _(jaywcjlove.github.io)_
- [在线编译预览](http://lesscss.org/less-preview/#eyJjb2RlIjoiI2xpYigpIHtcbiAgICAuY29sb3JzKCkge1xuICAgICAgQHByaW1hcnk6IGJsdWU7XG4gICAgICBAc2Vjb25kYXJ5OiBncmVlbjtcbiAgICB9XG4gICAgLnJ1bGVzKEBzaXplKSB7XG4gICAgICBib3JkZXI6IEBzaXplIHNvbGlkIHdoaXRlO1xuICAgIH1cbiAgfVxuICBcbiAgLmJveCB3aGVuICgjbGliLmNvbG9yc1tAcHJpbWFyeV0gPSBibHVlKSB7XG4gICAgd2lkdGg6IDEwMHB4O1xuICAgIGhlaWdodDogKCR3aWR0aCAvIDIpO1xuICB9XG4gIFxuICAuYmFyOmV4dGVuZCguYm94KSB7XG4gICAgQG1lZGlhIChtaW4td2lkdGg6IDYwMHB4KSB7XG4gICAgICB3aWR0aDogMjAwcHg7XG4gICAgICAjbGliLnJ1bGVzKDFweCk7XG4gICAgfVxuICB9IiwiYWN0aXZlVmVyc2lvbiI6IjQueCJ9) _(lesscss.org)_
- [Less.js 官方文档](https://lesscss.org/) _(lesscss.org)_

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

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

@QinIndexCode 在线编译预览 是个工具,你可以添加个官方文档

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

已恢复“在线编译预览”工具链接,同时额外添加 Less.js 官方文档入口。

Comment thread docs/react.md Outdated
- [检测意外的副作用](https://zh-hans.reactjs.org/docs/strict-mode.html#detecting-unexpected-side-effects)
- [检测过时的 context API](https://zh-hans.reactjs.org/docs/strict-mode.html#detecting-legacy-context-api)
- [确保可复用的状态](https://zh-hans.reactjs.org/docs/strict-mode.html#ensuring-reusable-state)
- 重新渲染组件以发现不纯渲染

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

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

@QinIndexCode 为什么删除了链接地址?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

已恢复 StrictMode 相关列表链接,并保留新的 react.dev StrictMode 参考入口。

Comment thread docs/vue2.md Outdated
===

渐进式 JavaScript 框架 [Vue 2](https://v2.cn.vuejs.org/) 备忘清单的快速参考列表,包含常用 API 和示例。
渐进式 JavaScript 框架 [Vue 2](https://v2.vuejs.org/) 备忘清单的快速参考列表,包含常用 API 和示例。Vue 2 已于 2023 年 12 月 31 日结束官方维护,新项目建议使用 Vue 3

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

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

@QinIndexCode 这是 vue2 的速查手册,不需要说明什么,比如什么时候不维护

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

已撤回 Vue 2 EOL/不维护说明,恢复为原来的 Vue 2 速查手册描述。

Comment thread docs/vue2.md Outdated
<!--rehype:className=style-round-->

注意:Vue 2.x 版本对应 Vue Router 3.x 路由版本
注意:Vue 2.x 版本对应 Vue Router 3.x 路由版本;维护旧项目时应同步评估迁移 Vue 3。

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

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

不需要说明苹果迁移的问题,因为这是一分 vue 2 的速查手册

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

已删除迁移建议,恢复为“Vue 2.x 版本对应 Vue Router 3.x 路由版本”的简洁说明。

@QinIndexCode QinIndexCode force-pushed the docs/refresh-official-references branch from b526055 to 09e6490 Compare June 18, 2026 01:02
Sign up for free to 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.

2 participants