Skip to content

docs: fixed some problems#8

Merged
JohnRichard4096 merged 2 commits intomainfrom
docs/resolve-problems
Feb 12, 2026
Merged

docs: fixed some problems#8
JohnRichard4096 merged 2 commits intomainfrom
docs/resolve-problems

Conversation

@JohnRichard4096
Copy link
Member

@JohnRichard4096 JohnRichard4096 commented Feb 12, 2026

Summary by Sourcery

Clarify and streamline the AmritaCore appendix documentation in both English and Chinese guides.

Documentation:

  • Update the official website description and remove outdated related-project listings in the English appendix, while pointing contributors to CONTRIBUTING.md for more information.
  • Update the Chinese appendix to mirror the English changes to the website description, remove the related-project section, and reference the CONTRIBUTING.md file for contribution details.

@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Feb 12, 2026

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Updates 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

Change Details Files
Align appendix website and contribution sections with current project reality in both English and Chinese docs.
  • Update the website description text to indicate the linked AmritaCore site is the real, current site instead of hypothetical
  • Remove now-irrelevant 'Related Projects (Proj.Amrita)' subsection listing AmritaBot, AmritaUI, and AmritaTools
  • Renumber the 'Contribution Guidelines' heading to immediately follow the website section after removing the related projects section
  • Add a sentence pointing readers to the repository's CONTRIBUTING.md file for more detailed contribution information in both languages
docs/guide/appendix.md
docs/zh/guide/appendix.md
Minor formatting/consistency tweak in Chinese management concepts doc.
  • Ensure the last line in the security controls cross-reference is properly terminated and formatted
docs/zh/guide/concepts/management.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

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>

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
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>
@cloudflare-workers-and-pages
Copy link

cloudflare-workers-and-pages bot commented Feb 12, 2026

Deploying amritacore with  Cloudflare Pages  Cloudflare Pages

Latest commit: de29708
Status: ✅  Deploy successful!
Preview URL: https://57b21195.amritacore.pages.dev
Branch Preview URL: https://docs-resolve-problems.amritacore.pages.dev

View logs

@JohnRichard4096 JohnRichard4096 merged commit 7f325cd into main Feb 12, 2026
3 checks passed
@JohnRichard4096 JohnRichard4096 deleted the docs/resolve-problems branch February 12, 2026 08:31
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.

1 participant