Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clean up and expand readme #31

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Clean up and expand readme #31

wants to merge 1 commit into from

Conversation

parlough
Copy link
Member

@parlough parlough commented Dec 19, 2024

  • Fix a few minor typo, punctuation, and grammar issues
  • Adjust wording for clarity
  • Add more cross links to Flutter, Firebase, and package docs where relevant
  • Add alt text to screenshot and make it a link target as well
  • Adjust sections of text that are links
  • Use Markdown and GFM features where appropriate (ordered list, warning blocks, etc)
  • Add some line breaks and separate link definitions for easier editing and review
  • Update comments in code blocks to more closely follow Effective Dart
  • Adjust placeholders (...) in code snippets to be in comments to make them directly copyable
  • Other misc and minor adjustments

@csells
Copy link
Contributor

csells commented Dec 19, 2024

When I preview the updated README in this PR, the paragraph flow is gone and all of the lines are unnaturally shortened:

image

@domesticmouse
Copy link
Contributor

Please resolve conflicts =)

@@ -1,7 +1,7 @@
name: flutter_ai_toolkit
description: >-
A set of AI chat-related widgets for Flutter apps targeting
mobile, desktop and web.
mobile, desktop, and web.
Copy link
Contributor

Choose a reason for hiding this comment

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

🎉

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.

3 participants