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

Enhance Documentation with Pipeline Images and Streamlined Content #142

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

Conversation

JSchmie
Copy link
Owner

@JSchmie JSchmie commented Dec 20, 2024

This PR introduces the following updates:

  1. Added Pipeline Images: Reintroduced and resized images of the ScrAIbe pipeline for better readability and a cleaner layout.
  2. Refined Documentation: Adjusted content structure to improve clarity, including:
    • Streamlined installation instructions.
    • Highlighted Python and CLI usage examples.
  3. Updated Contributions Section: Enhanced visibility of contribution guidelines and acknowledgments.

Purpose

These changes aim to improve user experience by providing a concise, visually appealing overview of the ScrAIbe pipeline and ensuring the documentation remains user-friendly and well-organized.


Preview

  • Pipeline images are now displayed at 40% width for better integration.
  • Cleaner separation of sections with clear headings and examples.

Notes

  • No breaking changes introduced.
  • Ready for review and feedback.

@JSchmie JSchmie requested a review from mahenning December 20, 2024 14:05
@JSchmie JSchmie self-assigned this Dec 20, 2024
@github-actions github-actions bot added documentation Improvements or additions to documentation ignore-pr-title-for-release release labels Dec 20, 2024
@JSchmie JSchmie changed the base branch from main to develop December 20, 2024 14:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant