Improve README formatting for official website section#916
Open
Keerthana-webdev wants to merge 1 commit intofossasia:gh-pagesfrom
Open
Improve README formatting for official website section#916Keerthana-webdev wants to merge 1 commit intofossasia:gh-pagesfrom
Keerthana-webdev wants to merge 1 commit intofossasia:gh-pagesfrom
Conversation
Reviewer's guide (collapsed on small PRs)Reviewer's GuideUpdates 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
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
Author
|
Hi @mariobehling 👋 |
There was a problem hiding this comment.
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.Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
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.
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
Checklist:
Summary by Sourcery
Documentation: