Skip to content

Commit 54ea216

Browse files
committed
add caution badge and correct numbering sequence
1 parent 3372847 commit 54ea216

File tree

1 file changed

+12
-8
lines changed

1 file changed

+12
-8
lines changed

docs/guides/cloud/projects.mdx

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -348,25 +348,29 @@ test count to other developers viewing your project's README file.
348348

349349
#### Create a README badge
350350

351-
1. In your Cypress Cloud account, select the project for which youd like to
352-
1. On the Project Settings page, scroll down to the README Badges section and
351+
1. In your Cypress Cloud account, select the project for which you'd like to
352+
2. On the Project Settings page, scroll down to the README Badges section and
353353
click “Configure Badge”.
354354

355-
**Note**: README badges are currently only available for public projects.
355+
:::caution
356+
357+
**Note**: README badges are currently only available for public projects.
358+
359+
:::
356360

357-
1. A configuration modal will appear. The Project ID will be pre-filled with the
361+
3. A configuration modal will appear. The Project ID will be pre-filled with the
358362
ID associated with the project you selected. You can choose to designate a
359363
specific branch, or leave this field blank to always use the latest build in
360364
the project.
361-
1. Next, style your badge. Flat is the default styling and is most commonly
365+
4. Next, style your badge. Flat is the default styling and is most commonly
362366
used, but 5 style options are available.
363-
1. Select the badge type to change the amount and type of information that's
367+
5. Select the badge type to change the amount and type of information that's
364368
displayed. Simple status will show only whether tests are passing or failing.
365369
Detailed status will show the number of tests that were passed, failed, or
366370
skipped. Test count will show how many tests are included in your project.
367-
1. Once you've selected all your settings, check out the preview and make sure
371+
6. Once you've selected all your settings, check out the preview and make sure
368372
everything looks just the way you like it.
369-
1. 🎉 Your badge is ready to be embedded. Copy the markdown at the bottom of the
373+
7. 🎉 Your badge is ready to be embedded. Copy the markdown at the bottom of the
370374
Configure Badge modal, and embed it in your project's README file for
371375
everyone to see!
372376

0 commit comments

Comments
 (0)