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

docs: General doc improvements #610

Merged
merged 3 commits into from
Jul 30, 2024
Merged

docs: General doc improvements #610

merged 3 commits into from
Jul 30, 2024

Conversation

bellini666
Copy link
Member

@bellini666 bellini666 commented Jul 30, 2024

  • docs: Improve docs sections and ordering
  • docs: Replace :material: icons usage with emojis
  • docs: Avoid backticks after [!TIP] as the formatter forces it to the same line and breaks the style

Summary by Sourcery

This pull request improves the documentation by reorganizing sections, replacing :material: icons with emojis, and fixing a formatting issue with backticks after [!TIP].

  • Documentation:
    • Reorganized documentation sections for better clarity and navigation.
    • Replaced :material: icons with emojis for better visual consistency.
    • Fixed formatting issue with backticks after [!TIP] to maintain style integrity.

@bellini666 bellini666 self-assigned this Jul 30, 2024
Copy link
Contributor

sourcery-ai bot commented Jul 30, 2024

Reviewer's Guide by Sourcery

This pull request focuses on improving the documentation by reorganizing sections, replacing material icons with emojis, and fixing formatting issues with tips. The changes are primarily in the documentation files, enhancing readability and consistency.

File-Level Changes

Files Changes
docs/README.md
docs/community-projects.md
Reorganized documentation sections and replaced material icons with emojis for better readability and consistency.

Tips
  • Trigger a new Sourcery review by commenting @sourcery-ai review on the pull request.
  • Continue your discussion with Sourcery by replying directly to review comments.
  • You can change your review settings at any time by accessing your dashboard:
    • Enable or disable the Sourcery-generated pull request summary or reviewer's guide;
    • Change the review language;
  • You can always contact us if you have any questions or feedback.

@bellini666 bellini666 requested a review from patrick91 July 30, 2024 13:26
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 @bellini666 - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

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 to tell me if it was helpful.

Copy link
Member

@patrick91 patrick91 left a comment

Choose a reason for hiding this comment

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

neat!

@bellini666 bellini666 merged commit 9c7fe90 into main Jul 30, 2024
22 checks passed
@bellini666 bellini666 deleted the improve_docs branch July 30, 2024 13:29
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.

2 participants