docs: Improve docs #2141
docs: Improve docs #2141
Conversation
unknowIfGuestInDream
requested a review
from DreamAwakenFateBroke
as a code owner
|
Thank you for following naming conventions! 😻 |
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
Their most recently public accepted PR is: #2134 |
|
Caution Review failedThe pull request is closed. """ Walkthrough本次变更主要涉及将 Changes
Assessment against linked issues
Suggested labels
Suggested reviewers
Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
Reviewer's GuideThis pull request updates the JavaFX API URL from version 17 to 21 in File-Level Changes
Assessment against linked issues
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
github-actions
bot
added
documentation
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hey @unknowIfGuestInDream - I've reviewed your changes - here's some feedback:
- This PR includes a code change to
CoreConstant.JAVAFX_API_URL; consider updating the PR title to reflect this. - The 'Proposed Changes' section in the PR description should be completed to outline the updates.
Here's what I looked at during the review
- 🟡 General issues: 1 issue found
- 🟢 Security: all looks good
- 🟢 Testing: all looks good
- 🟢 Documentation: all looks good
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (2)
docs/overview/Into.md (1)
3-3: 统一大小写及格式
建议将javafx和controlsfx按官方品牌规范改为JavaFX与ControlsFX，并在版本号与关键词间添加空格：- javafx脚手架，基于JDK17 + JavaFX21 + controlsfx 11 + Maven开发。 + JavaFX 脚手架，基于 JDK17 + JavaFX 21 + ControlsFX 11 + Maven 开发。docs/develop/Note.md (1)
9-9: 移除多余转义字符
行末的反斜杠\会导致 Markdown 换行或转义异常，请删除反斜杠，使内容渲染正常：- **升级版本号**\ + **升级版本号**
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
core/src/main/java/com/tlcsdm/core/util/CoreConstant.java(1 hunks)docs/develop/Note.md(1 hunks)docs/overview/Into.md(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (9)
- GitHub Check: build (21, macos-latest, false)
- GitHub Check: build (21, windows-latest, false)
- GitHub Check: build (17, windows-latest, false)
- GitHub Check: build (21, ubuntu-latest, false)
- GitHub Check: qodana
- GitHub Check: build (17, ubuntu-latest, false)
- GitHub Check: build (17, macos-latest, false)
- GitHub Check: StepSecurity Harden-Runner
- GitHub Check: Summary
🔇 Additional comments (1)
core/src/main/java/com/tlcsdm/core/util/CoreConstant.java (1)
44-44:✅ Verification successful
更新 JavaFX API 文档常量至 21
已将JAVAFX_API_URL从https://openjfx.io/javadoc/17更新至https://openjfx.io/javadoc/21，符合本次升级目标。请运行以下脚本，确保仓库中不再存在旧版本链接：
🏁 Script executed:
#!/bin/bash rg -n "openjfx.io/javadoc/17"Length of output: 29
确认已更新 JavaFX API 文档链接至 v21
已将JAVAFX_API_URL从https://openjfx.io/javadoc/17更新至https://openjfx.io/javadoc/21，并确认仓库中不再包含旧版本链接。
- 文件：core/src/main/java/com/tlcsdm/core/util/CoreConstant.java（第44行）
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
docs/develop/Note.md (1)
7-10: 检查发布新版本小节语法
“升级版本号\”行末反斜杠用于换行，需确认在最终文档中是否有预期效果，或考虑使用更直观的换行方式。
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
core/src/main/java/com/tlcsdm/core/util/CoreConstant.java(1 hunks)docs/develop/Note.md(1 hunks)docs/overview/Into.md(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (10)
- GitHub Check: automerge
- GitHub Check: build (21, macos-latest, false)
- GitHub Check: build (21, windows-latest, false)
- GitHub Check: build (17, windows-latest, false)
- GitHub Check: build (21, ubuntu-latest, false)
- GitHub Check: qodana
- GitHub Check: build (17, ubuntu-latest, false)
- GitHub Check: build (17, macos-latest, false)
- GitHub Check: StepSecurity Harden-Runner
- GitHub Check: Summary
🔇 Additional comments (3)
core/src/main/java/com/tlcsdm/core/util/CoreConstant.java (1)
44-44: 确认 JavaFX API 版本常量更新
已将JAVAFX_API_URL常量从 17 升级至 21，保持与文档一致。请验证该链接可正常访问最新文档，并检查项目其他地方对该常量的引用是否同步更新。docs/overview/Into.md (1)
3-3: 更新项目概述中的版本信息
已将文档中的 JavaFX 版本升级至 21，并将 controlsfx 固定为 11，提升描述准确性。请确认文档所示版本与实际依赖版本保持一致。docs/develop/Note.md (1)
3-6: 新增 JavaFX 升级提示
在“依赖更新”部分加入!> Javafx 升级和CoreConstant.JAVAFX_API_URL，有效强调 JavaFX 升级信息。建议预览渲染效果，确保语法正确。
Qodana Community for JVMIt seems all right 👌 No new problems were found according to the checks applied 💡 Qodana analysis was run in the pull request mode: only the changed files were checked Contact Qodana teamContact us at qodana-support@jetbrains.com
|
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
docs/overview/Into.md (2)
3-3: 确认版本说明准确无误
“javafx脚手架，基于JDK17 + JavaFX21 + controlsfx 11 + Maven开发。” 已更新为 JavaFX 21 和 controlsfx 11，整体符合 PR 目标。建议将 “controlsfx” 首字母大写为 “ControlsFX”，以保持与 “JavaFX” 等项目名称的一致性。
37-43: 建议为裸露 URL 添加链接文本
第 42 行的裸露 URL 会触发 MD034（no-bare-urls）警告，建议改为带描述的 Markdown 链接或使用尖括号包裹。例如：- https://github.com/unknowIfGuestInDream/javafxTool/actions/workflows/artifact.yml + [查看最新构建工件](https://github.com/unknowIfGuestInDream/javafxTool/actions/workflows/artifact.yml)或
<https://github.com/unknowIfGuestInDream/javafxTool/actions/workflows/artifact.yml>🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
42-42: Bare URL used
null(MD034, no-bare-urls)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
docs/overview/Into.md(2 hunks)jenkins/jre.sh(1 hunks)
✅ Files skipped from review due to trivial changes (1)
- jenkins/jre.sh
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
docs/overview/Into.md
42-42: Bare URL used
null
(MD034, no-bare-urls)
⏰ Context from checks skipped due to timeout of 90000ms (9)
- GitHub Check: qodana
- GitHub Check: build (21, windows-latest, false)
- GitHub Check: build (17, windows-latest, false)
- GitHub Check: build (21, ubuntu-latest, false)
- GitHub Check: build (17, ubuntu-latest, false)
- GitHub Check: build (17, macos-latest, false)
- GitHub Check: build (21, macos-latest, false)
- GitHub Check: StepSecurity Harden-Runner
- GitHub Check: Summary
🔇 Additional comments (1)
docs/overview/Into.md (1)
35-35: 模块列表更新：添加 jenkins 模块
“jenkins: 打包和工作流构建时需要的文件” 已正确纳入代码结构，无需额外调整。
Signed-off-by: unknowIfGuestInDream <liang.tang.cx@gmail.com>
Signed-off-by: unknowIfGuestInDream <liang.tang.cx@gmail.com>
Signed-off-by: unknowIfGuestInDream <liang.tang.cx@gmail.com>
unknowIfGuestInDream
force-pushed
the
ddddccc
branch
from
b9cb8cb to
a419298
Compare
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (6)
docs/_sidebar.md (1)
12-13: 修正列表缩进以符合 Markdown 风格
静态分析提示 (MD007)：列表项缩进应为 2 个空格一级，但当前新增的 “Common” 子项及其链接分别使用了 4/8 个空格。请将缩进调整为与其他同级条目一致：- - Common - - [介绍](common/Into.md) + - Common + - [介绍](common/Into.md)🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
12-12: Unordered list indentation
Expected: 2; Actual: 4(MD007, ul-indent)
13-13: Unordered list indentation
Expected: 4; Actual: 8(MD007, ul-indent)
docs/overview/Into.md (3)
3-3: 库名称规范和空格维护
建议将controlsfx 11标注为ControlsFX 11，并在符号两侧添加空格：- JavaFX 21 + controlsfx 11 + Maven开发 + JavaFX 21 + ControlsFX 11 + Maven 开发
35-35: 模块名称首字母大写
建议将jenkins模块名称修改为Jenkins，以与其他模块保持一致。
37-37: 优化 CI/CD 标题本地化
建议将标题## CI/CD改为## 持续集成/持续交付 (CI/CD)，并将子标题中的Github Workflow Build改为GitHub 工作流构建，提高中文文档一致性和品牌名称正确性。docs/develop/Note.md (2)
12-13: 常量和代码引用请加反引号并统一大小写
将CoreConstant.JAVAFX_API_URL和JavaFX等引用用反引号包裹，并统一正确大小写，例如：- CoreConstant.JAVAFX_API_URL 修改javaFX API路径 + `CoreConstant.JAVAFX_API_URL` 修改 `JavaFX API` 路径
20-23: 统一平台工具名称大小写
请将Github、jenkins等名称统一为GitHub、Jenkins，以保持文档专业和一致。
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (14)
README.md(1 hunks)README_jp.md(1 hunks)README_zh.md(1 hunks)core/src/main/java/com/tlcsdm/core/util/CoreConstant.java(1 hunks)docs/README.md(1 hunks)docs/_sidebar.md(1 hunks)docs/common/Into.md(1 hunks)docs/develop/Note.md(1 hunks)docs/develop/Package.md(1 hunks)docs/index.html(3 hunks)docs/overview/Env.md(1 hunks)docs/overview/Into.md(2 hunks)docs/smc/Into.md(1 hunks)jenkins/jre.sh(1 hunks)
✅ Files skipped from review due to trivial changes (9)
- docs/common/Into.md
- docs/README.md
- docs/smc/Into.md
- README_zh.md
- README.md
- README_jp.md
- docs/overview/Env.md
- docs/develop/Package.md
- docs/index.html
🚧 Files skipped from review as they are similar to previous changes (2)
- core/src/main/java/com/tlcsdm/core/util/CoreConstant.java
- jenkins/jre.sh
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
docs/_sidebar.md
12-12: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
13-13: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
⏰ Context from checks skipped due to timeout of 90000ms (9)
- GitHub Check: qodana
- GitHub Check: build (21, windows-latest, false)
- GitHub Check: build (21, ubuntu-latest, false)
- GitHub Check: build (17, macos-latest, false)
- GitHub Check: build (21, macos-latest, false)
- GitHub Check: build (17, windows-latest, false)
- GitHub Check: build (17, ubuntu-latest, false)
- GitHub Check: StepSecurity Harden-Runner
- GitHub Check: Summary
Signed-off-by: unknowIfGuestInDream <liang.tang.cx@gmail.com>
|
Fixes #1746
Proposed Changes
Readiness Checklist
Author/Contributor
Reviewing Maintainer
enhancement,bug,documentationordependenciesSummary by Sourcery
Update documentation to reflect JavaFX version changes and improve project documentation
Enhancements:
Documentation:
Summary by CodeRabbit