chore(repo): Improve READMEs #4053
Conversation
This reverts commit 07f707f.
🦋 Changeset detectedLatest commit: 37bf442 The changes in this PR will be included in the next version bump. This PR includes changesets to release 19 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
| This ensures that all internal TypeScript types are generated and any dependencies between packages are resolving. | ||
|
|
||
| For package specific setup, refer to the `Build` section of the specific package (e.g. `packages/<package_name>/README.md#build`). | ||
| Once you're ready to make changes, run `npm run dev` from the monorepo root. |
There was a problem hiding this comment.
Since I removed the "Build" instructions from the READMEs I made this addition
| [Request a Feature](https://feedback.clerk.com/roadmap) | ||
| · | ||
| [Ask a Question](https://github.com/clerk/javascript/discussions) | ||
| [Get help](https://clerk.com/contact/support?utm_source=github&utm_medium=clerk_astro) |
There was a problem hiding this comment.
We disabled Github Discussions so no use to link to that
There was a problem hiding this comment.
Stale file, cleanup 🧹
| ```shell | ||
| npm install @clerk/chrome-extension | ||
| ``` | ||
| 1. Add `@clerk/chrome-extension` to your project: |
There was a problem hiding this comment.
The Chrome Extension docs are not live yet, so we keep it for now
| ## Usage | ||
|
|
||
| Retrieve your Backend API key from the [API Keys](https://dashboard.clerk.com/last-active?path=api-keys) screen in your Clerk dashboard and set it as an environment variable in a `.env` file: | ||
| Navigate to the [Clerk Dashboard](https://dashboard.clerk.com/last-active?path=api-keys) and inside the **API Keys** section copy the publishable key and secret key. |
There was a problem hiding this comment.
Express docs are not live yet so we keep them here for now
| npm run dev | ||
| ``` | ||
|
|
||
| ## Usage |
There was a problem hiding this comment.
Once Tanstack Start docs are live we can also change this
Description
While going through all our SDK READMEs I noticed some inconsistencies, outdated information, and generally speaking too much information that already lives in the docs (as source of truth). By linking to the docs we'll make our lives easier in the future since we don't need to change information in multiple places.
Examples preview: https://github.com/clerk/javascript/blob/readme-updates/packages/nextjs/README.md
Fixes ECO-166
Checklist
npm testruns as expected.npm run buildruns as expected.Type of change