Conversation
Contributor
Reviewer's guide (collapsed on small PRs)Reviewer's GuideUpdates English and Chinese appendix docs to reflect the real AmritaCore website, removes outdated related-projects sections, renumbers the contribution guidelines headings, and adds explicit references to CONTRIBUTING.md, plus a minor formatting fix in a Chinese concepts doc. File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
Contributor
There was a problem hiding this comment.
Hey - I've found 1 issue, and left some high level feedback:
- In
docs/guide/appendix.md, the sentence "For more details, refer to the project's CONTRIBUTING.md file for more details." is redundant; consider removing the second "for more details" for clarity. - The new note "(Yes, it's this site!)" in the English appendix is more informal than the surrounding documentation; consider aligning its tone with the rest of the guide for consistency.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- In `docs/guide/appendix.md`, the sentence "For more details, refer to the project's CONTRIBUTING.md file for more details." is redundant; consider removing the second "for more details" for clarity.
- The new note "(Yes, it's this site!)" in the English appendix is more informal than the surrounding documentation; consider aligning its tone with the rest of the guide for consistency.
## Individual Comments
### Comment 1
<location> `docs/guide/appendix.md:57` </location>
<code_context>
### 8.2.2 Official Website
-- **Website**: [https://amrita-core.suggar.top](amrita-core.suggar.top) (hypothetical)
+- **Website**: [https://amrita-core.suggar.top](amrita-core.suggar.top) (Yes, it's this site!)
- **Documentation**: Comprehensive guides and tutorials
- **Community Forum**: Connect with other users and developers
</code_context>
<issue_to_address>
**suggestion (bug_risk):** Consider making the link target a fully qualified URL to match the link text.
The link text includes `https://`, but the target omits the scheme (`amrita-core.suggar.top`). To prevent possible rendering issues and stay consistent with the Chinese version, please update the target to `https://amrita-core.suggar.top`.
```suggestion
- **Website**: [https://amrita-core.suggar.top](https://amrita-core.suggar.top) (Yes, it's this site!)
```
</issue_to_address>Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>
Deploying amritacore with
|
| Latest commit: |
de29708
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://57b21195.amritacore.pages.dev |
| Branch Preview URL: | https://docs-resolve-problems.amritacore.pages.dev |
This file contains hidden or 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
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.
Summary by Sourcery
Clarify and streamline the AmritaCore appendix documentation in both English and Chinese guides.
Documentation: