Skip to content

Conversation

@mkopcins
Copy link
Collaborator

@mkopcins mkopcins commented Oct 23, 2025

Description

Add minor improvements to README.md:

  • Add additional badges (stars, documentation, and contributors)
  • Center badges and library name at the top of the readme
  • Change link from GH of Private Mind to landing page
  • Add accordion on Table of Content
  • Fix spelling of ExecuTorch in one place
  • Add consistent title case for all sub-headings
  • Move documentation section (Right now, there is also badge with documentation, so section about documentation doesn't need to be at the top of README.md anymore)

If every change is ok, analogical changes need to be done in different languages

Introduces a breaking change?

  • Yes
  • No

Type of change

  • Bug fix (change which fixes an issue)
  • New feature (change which adds functionality)
  • Documentation update (improves or adds clarity to existing documentation)
  • Other (chores, tests, code style improvements etc.)

Tested on

  • iOS
  • Android

Testing instructions

Screenshots

Related issues

Checklist

  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have updated the documentation accordingly
  • My changes generate no new warnings

Additional notes

Right now, there is also badge with documentation, so section about documentation doesn't need to be at the top of README.md anymore
@msluszniak msluszniak self-assigned this Oct 23, 2025
@msluszniak msluszniak added documentation Improvements or additions to documentation chore PRs that are chores labels Oct 23, 2025
@msluszniak msluszniak requested a review from IgorSwat October 23, 2025 15:22
@msluszniak msluszniak merged commit 956ecae into main Oct 29, 2025
2 checks passed
@msluszniak msluszniak deleted the @ms/update-readme branch October 29, 2025 15:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

chore PRs that are chores documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants