Skip to content

Improve README formatting for official website section#916

Open
Keerthana-webdev wants to merge 1 commit intofossasia:gh-pagesfrom
Keerthana-webdev:improve-docs-formatting
Open

Improve README formatting for official website section#916
Keerthana-webdev wants to merge 1 commit intofossasia:gh-pagesfrom
Keerthana-webdev:improve-docs-formatting

Conversation

@Keerthana-webdev
Copy link
Copy Markdown

@Keerthana-webdev Keerthana-webdev commented Mar 21, 2026

Description

Improved the formatting of the official website link in the README by converting it into a proper Markdown link and adding a clear section heading.

Motivation and Context

Enhances readability and removes the trailing period issue in the link.

Types of changes

  • Code refactor or cleanup

Checklist:

  • My code follows the code style of this project.
  • My change improves documentation.

Summary by Sourcery

Documentation:

  • Reformat the official website reference into a dedicated Markdown section with a clear heading and link styling.

@sourcery-ai
Copy link
Copy Markdown

sourcery-ai bot commented Mar 21, 2026

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Updates the README documentation to introduce a dedicated 'Official Website' section and convert the plain-text URL into a clearer Markdown-formatted link with improved readability.

File-Level Changes

Change Details Files
Reformatted the 'Official website' line into a dedicated section with a Markdown link for improved readability.
  • Replaced the single-line 'Official website: https://fossasia.org' text with a second-level heading labeled 'Official Website'.
  • Added a short lead-in sentence inviting readers to visit the FOSSASIA website.
  • Converted the plain-text URL into a Markdown-formatted link, visually highlighted with a leading icon marker.
README.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

@Keerthana-webdev
Copy link
Copy Markdown
Author

Hi @mariobehling 👋
I’ve made a small documentation improvement to enhance readability of the README.
Please let me know if any changes are needed. Thanks!

Copy link
Copy Markdown

@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 left some high level feedback:

  • Consider removing the emoji from the README since the rest of the document appears to use a more neutral, text-only style for headings and content.
  • You might want to use a descriptive link label instead of the raw URL (e.g., [FOSSASIA official website](https://fossasia.org)) to improve accessibility and readability.
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- Consider removing the emoji from the README since the rest of the document appears to use a more neutral, text-only style for headings and content.
- You might want to use a descriptive link label instead of the raw URL (e.g., `[FOSSASIA official website](https://fossasia.org)`) to improve accessibility and readability.

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.

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