doc: soft-link docs/README.md to README #619
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Diwank Singh Tomer <[email protected]>
![ellipsis-dev[bot]](https://avatars.githubusercontent.com/in/64358?s=60&v=4){kind=small}
There was a problem hiding this comment.
👍 Looks good to me! Reviewed everything up to 7482213 in 19 seconds
More details
- Looked at
736lines of code in3files - Skipped
0files when reviewing. - Skipped posting
1drafted comments based on config settings.
1. README.md:1
- Draft comment:
Using absolute URLs for internal links (e.g., to README-CN.md and README-JP.md) is not ideal. Consider using relative paths to ensure links work across branches and forks. - Reason this comment was not posted:
Decided after close inspection that this draft comment was likely wrong and/or not actionable:
The comment is directly related to a change made in the diff, where relative paths were replaced with absolute URLs. The suggestion to use relative paths is a valid code quality improvement, as it ensures links work across branches and forks. This is actionable and clear, aligning with the rules for review comments.
The comment assumes that using relative paths is always better, but there might be a specific reason for using absolute URLs that the author had in mind. Without knowing the author's intention, it's speculative to suggest a change.
The suggestion to use relative paths is a common best practice for internal links in documentation, and unless there's a specific reason provided for using absolute URLs, the comment is likely valid.
Keep the comment as it provides a valid suggestion for improving the code quality by using relative paths for internal links.
Workflow ID: wflow_VKSxkjGm1aM2I1HD
You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.
Signed-off-by: Diwank Singh Tomer <[email protected]>
There was a problem hiding this comment.
👍 Looks good to me! Incremental review on 25187bd in 13 seconds
More details
- Looked at
961lines of code in2files - Skipped
0files when reviewing. - Skipped posting
1drafted comments based on config settings.
1. docs/README.md:1
- Draft comment:
Thedocs/README.mdfile should be a symbolic link toREADME.mdas per the PR description, but it currently contains a full copy of the README content. Please replace it with a symbolic link. - Reason this comment was not posted:
Comment was not on a valid diff hunk.
Workflow ID: wflow_t3OPOr4p5JiAYfC4
You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.
Signed-off-by: Diwank Singh Tomer <[email protected]>
Signed-off-by: Diwank Singh Tomer <[email protected]>
There was a problem hiding this comment.
👍 Looks good to me! Incremental review on 00cba9f in 15 seconds
More details
- Looked at
954lines of code in1files - Skipped
0files when reviewing. - Skipped posting
1drafted comments based on config settings.
1. docs/README.md:1
- Draft comment:
The filedocs/README.mdshould be a symbolic link toREADME.md, but it currently contains a full copy of the README content. Please replace it with a symbolic link. - Reason this comment was not posted:
Comment was on unchanged code.
Workflow ID: wflow_aTl1FQhZosX2BpCY
You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Signed-off-by: Diwank Singh Tomer [email protected]
Important
Replace
docs/README.mdwith a symbolic link toREADME.mdfor consistency and reduced redundancy.docs/README.mdwith a symbolic link toREADME.mdto ensure consistency and reduce redundancy.This description was created by
for 00cba9f. It will automatically update as commits are pushed.