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

Unify README's formatting #172

Merged
merged 4 commits into from
Nov 16, 2024
Merged

Conversation

marc-aurele-besner
Copy link
Member

@marc-aurele-besner marc-aurele-besner commented Nov 16, 2024

User description

Unify README's formatting

Simply trying to unify our different README's from different packages so they all look alike


PR Type

documentation


Description

  • Unified the formatting of README files across different packages for consistency.
  • Added a new package entry for @autonomys/auto-drive in the root README.
  • Enhanced the auto-drive README with badges and additional sections such as License, Additional Resources, and Contact.
  • Updated titles in package-specific READMEs to follow a consistent naming convention.

Changes walkthrough 📝

Relevant files
Documentation
README.md
Add Auto-Drive package to root README                                       

README.md

  • Added a new package entry for @autonomys/auto-drive.
+1/-0     
README.md
Update title for Auto DAG Data README                                       

packages/auto-dag-data/README.md

  • Updated the title to "Autonomys Auto DAG Data SDK".
+1/-1     
README.md
Enhance Auto Drive README with badges and sections             

packages/auto-drive/README.md

  • Updated title to "Autonomys Auto Drive SDK".
  • Added badges for GitHub release, build status, and npm version.
  • Included sections for License, Additional Resources, and Contact.
  • +25/-3   
    README.md
    Update title for Auto Utility README                                         

    packages/auto-utils/README.md

    • Updated the title to "Autonomys Auto Utility SDK".
    +1/-1     

    💡 PR-Agent usage: Comment /help "your question" on any pull request to receive relevant information

    Copy link

    PR Reviewer Guide 🔍

    Here are some key observations to aid the review process:

    ⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ No major issues detected

    Copy link

    PR Code Suggestions ✨

    No code suggestions found for the PR.

    clostao
    clostao previously approved these changes Nov 16, 2024
    Copy link
    Member

    @clostao clostao left a comment

    Choose a reason for hiding this comment

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

    LGTM

    Copy link
    Member

    @clostao clostao left a comment

    Choose a reason for hiding this comment

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

    just did this on mine doc PR

    @marc-aurele-besner marc-aurele-besner merged commit cc66a66 into main Nov 16, 2024
    1 check passed
    @marc-aurele-besner marc-aurele-besner deleted the chore/unify-readmes-formatting branch November 16, 2024 18:38
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    2 participants