Skip to content

Commit 55a02d6

Browse files
committed
Enhance documentation with improved phrasing
- Add exclamation marks for a more engaging tone in various sections. - Update phrasing to improve clarity and readability.
1 parent 3a0c8a1 commit 55a02d6

File tree

7 files changed

+14
-12
lines changed

7 files changed

+14
-12
lines changed

docs/contribute/docs/index.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,11 @@ sidebar_position: 1
77

88
# Contribute to the docs
99

10-
Welcome. Doc Detective is better because of contributors like you. Whether you're fixing a typo, adding an example, or writing comprehensive tutorials, your contribution matters.
10+
Welcome! Doc Detective is better because of contributors like you. Whether you're fixing a typo, adding an example, or writing comprehensive tutorials, your contribution matters.
1111

1212
## Good enough is better than perfect
1313

14-
You don't need to be a technical writer or documentation expert to contribute. If you see something that could be clearer, more accurate, or more helpful, you can improve it. We value accurate information over elegant prose—if you know something that should be documented, share it.
14+
You don't need to be a technical writer or documentation expert to contribute. If you see something that could be clearer, more accurate, or more helpful, you can improve it. We value accurate information over elegant prose—if you know something that should be documented, share it!
1515

1616
## Before you start
1717

@@ -83,7 +83,7 @@ If your PR doesn't get a response within our SLA, feel free to respectfully ping
8383

8484
## Recognition
8585

86-
All contributors are acknowledged in our release notes and on our contributors page. Thank you for making Doc Detective better.
86+
All contributors are acknowledged in our release notes and on our contributors page. Thank you for making Doc Detective better!
8787

8888
## Other ways to contribute
8989

docs/contribute/docs/review-process.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ In your pull request, you'll see status checks:
5050

5151
### If checks fail
5252

53-
Don't panic. Failed checks are common and can usually be fixed.
53+
Don't panic. Failed checks happen and can usually be fixed.
5454

5555
#### Vale failures
5656

@@ -279,7 +279,7 @@ Most disagreements resolve through discussion.
279279

280280
### When your PR is approved
281281

282-
Congratulations. Your contribution will be merged soon.
282+
Congratulations! Your contribution will be merged soon.
283283

284284
What happens next:
285285

@@ -289,7 +289,7 @@ What happens next:
289289

290290
### After merge
291291

292-
Celebrate. 🎉 You've contributed to open source. Post about it, add to your portfolio, tell your friends.
292+
Celebrate! 🎉 You've contributed to open source! Post about it, add to your portfolio, tell your friends.
293293

294294
If your PR addresses an issue, it should close automatically.
295295

@@ -369,7 +369,7 @@ Life happens. If you can't address feedback right away,
369369
- **Suggest improvements**: Open issues for documentation gaps you notice
370370
- **Join the community**: Engage in Discord discussions
371371

372-
### You're now a contributor
372+
### You're now a contributor!
373373

374374
Thank you for making Doc Detective better. Your contribution, no matter how small, helps all of our users.
375375

docs/contribute/docs/templates/tutorial.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -176,7 +176,7 @@ Tutorials should be encouraging:
176176

177177
✅ Good:
178178

179-
> Great. You've created your first test. Let's make it more useful by adding another action.
179+
> Great! You've created your first test. Let's make it more useful by adding another action.
180180
181181
⛔ Too formal:
182182

docs/get-started/installation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ Downloading and running Doc Detective is straightforward. Follow these steps to
5353
npx doc-detective --input sample.spec.json
5454
```
5555

56-
Congratulations. You've run your first test with Doc Detective.
56+
Congratulations! You've run your first test with Doc Detective.
5757

5858
## Next steps
5959

docs/get-started/intro.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ npx doc-detective
1313

1414
Want to use the Docker image? [Check it out](https://github.com/doc-detective/docker-image).
1515

16-
See the [Installation](/docs/get-started/installation.md) guide to get started. Come chat on [Discord](https://discord.gg/uAfSjVH7yr).
16+
See the [Installation](/docs/get-started/installation.md) guide to get started. Come chat on [Discord](https://discord.gg/uAfSjVH7yr)!
1717

1818
## What is Doc Detective?
1919

docs/get-started/tutorials/set-up-your-test-environment.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ You can use Doc Detective directly against your production site. For testing, it
1919
Replace `<path-to-expanded-test-examples>` with the actual path where you expanded the `TestExamples.zip` file.
2020
1. Install and run a webserver. Running your tests against a local server allows you to make edits and see them in real time. Also, you need to serve the files in a web browser to experiment with video recording and other features.
2121

22-
Any web server will do, but here are a few options (unassociated with Doc Detective):
22+
Any web server works, but here are a few options (unassociated with Doc Detective):
2323

2424
<Tabs>
2525
<TabItem value='python' label='Python'>

styles/config/vocabularies/Docs/accept.txt

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,8 @@ configPath
2424
contentPath
2525
contextId
2626
CTRL
27+
dragAndDrop
28+
draggable
2729
defaultCommand
2830
descriptionPath
2931
detectSteps
@@ -132,4 +134,4 @@ walkthrough
132134
webm
133135
webserver
134136
workingDirectory
135-
XPath
137+
XPath

0 commit comments

Comments
 (0)