Skip to content

Update README files to align with other Auth0 SDK repos and v1.0.0 release#255

Merged
rax7389 merged 9 commits intomainfrom
feat/readme-updates-myorg-ea
Apr 30, 2026
Merged

Update README files to align with other Auth0 SDK repos and v1.0.0 release#255
rax7389 merged 9 commits intomainfrom
feat/readme-updates-myorg-ea

Conversation

@SurajThotakura
Copy link
Copy Markdown
Member

Changes

  • Root & Package READMEs: Transitioned from contributor-focused to public-facing. Standardized layouts (Quick Nav, Docs, Feedback), fixed broken Auth0 URLs, updated image assets, and added standard Auth0 footers.
  • Example Apps (next-rwa, react-spa-*): * Streamlined setup by relying on the bootstrap script (removed manual CLI auth steps).
    • Added a manual configuration fallback guide (mandatory for private-cloud tenants).
    • Standardized the "Using Components" section across all examples.
    • Fixed shadcn specifics (corrected component install paths to components/auth0/, removed redundant init steps).
  • React Package (packages/react): Corrected install commands. Added npm metadata and keywords to package.json.
  • Core Package (packages/core): Updated description and added npm badges.
  • CONTRIBUTING.md: Created new file to house the monorepo architecture and local dev workflows previously in the root README
  • Added a gif in the root README to showcase our customization

References

Testing

Just updates to READMEs

  • This change adds unit test coverage
  • This change has been tested on the latest version of the platform/language or why not

Checklist

@SurajThotakura SurajThotakura added documentation Improvements or additions to documentation examples Changes are limited to the examples folder. refactor Restructuring existing code and logic to reduce technical debt and improve quality labels Apr 16, 2026
@codecov-commenter
Copy link
Copy Markdown

codecov-commenter commented Apr 16, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 89.42%. Comparing base (a8b6c32) to head (1ada7d0).

Additional details and impacted files
@@           Coverage Diff            @@
##             main     #255    +/-   ##
========================================
  Coverage   89.42%   89.42%            
========================================
  Files         159      159            
  Lines       13325    13325            
  Branches     1435     1749   +314     
========================================
  Hits        11916    11916            
  Misses       1409     1409            

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Comment thread examples/next-rwa/README.md
Comment thread examples/next-rwa/README.md
Comment thread README.md
Comment thread packages/react/package.json Outdated
Comment thread examples/next-rwa/README.md
Comment thread docs-site/public/auth0-ui-components-small.png Outdated
@SurajThotakura SurajThotakura requested a review from rax7389 April 20, 2026 04:19
@SurajThotakura SurajThotakura force-pushed the feat/readme-updates-myorg-ea branch from d20f389 to 6397253 Compare April 30, 2026 05:34
@rax7389 rax7389 merged commit 7d4b513 into main Apr 30, 2026
6 checks passed
@rax7389 rax7389 deleted the feat/readme-updates-myorg-ea branch April 30, 2026 06:25
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 examples Changes are limited to the examples folder. refactor Restructuring existing code and logic to reduce technical debt and improve quality

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants