Skip to content

Fix docs #405

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 10 commits into
base: main
Choose a base branch
from
Draft

Fix docs #405

wants to merge 10 commits into from

Conversation

chottuthejimmy
Copy link
Contributor

No description provided.

ericclemmons
ericclemmons previously approved these changes Aug 5, 2025
Copy link
Member

@ericclemmons ericclemmons left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good looking stuff! Tagged in @ianjennings about the TD_THIS_FILE variable being public vs. an "internal" variable we use for postrun.yaml

Copy link
Contributor

@ianjennings ianjennings left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some minor changes, probably want to remove that setup guide, since we don't need those deps anymore.

2. **API Key**: Your API key is used to authenticate your requests to the TestDriver API. You can regenerate it if you suspect it has been compromised.
3. **Usage & Billing**: Monitor your usage and billing information. This includes your current plan, usage limits, and billing history.
2. **Personal API Key**: Your personal API key that you can use for creating the tests.
3. **Shared API Key**: Your shared API key that can be used for CI/CD workflows.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

remove

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, so I made changes for the "user specific API key", like I added new image assets and all the other stuff, recently I saw we moved back, so I need to revert these 😕

Comment on lines -78 to -86
- name: Set up Node.js
uses: actions/setup-node@v4
with:
node-version: "20"
cache: "npm"

- name: Install dependencies
run: NODE_ENV=production npm ci

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

you sure we don't need this? how does npx run?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Comment on lines 55 to 61
#### Install Python & Visual Studio build tools

```powershell
choco install python visualstudio2022-workload-vctools -y
```

#### Install Node.js
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think this is still true?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this page will be hidden and will not be indexed (https://github.com/testdriverai/cli/pull/405/files/c38dada7555f7f1edccf5eaba6bbca285f2f0ab5#diff-50bd76e1e2b56dd4d7722b0a2ae3cb2804eb4f18ae8a3b50f9b1f38e5dc51a11R6), I just kept it in case we resume doing locally again, we can just pick from here

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we should delete it if it's not used

code stays in github forever, don't be afraid to delete!

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Got it
makes sense!

Comment on lines 73 to 75
```powershell
Set-ExecutionPolicy RemoteSigned -Scope CurrentUser
```
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We don't need this anymore.

<Card title="Test Copilot" icon="link" href="/getting-started/writing">
Write custom tests
</Card>
</CardGroup>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This page probably isn't needed anymore

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yup!

this page will be hidden and will not be indexed (https://github.com/testdriverai/cli/pull/405/files/c38dada7555f7f1edccf5eaba6bbca285f2f0ab5#diff-50bd76e1e2b56dd4d7722b0a2ae3cb2804eb4f18ae8a3b50f9b1f38e5dc51a11R6), I just kept it in case we resume doing locally again, we can just pick from here

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same as above

@ianjennings
Copy link
Contributor

Good looking stuff! Tagged in @ianjennings about the TD_THIS_FILE variable being public vs. an "internal" variable we use for postrun.yaml

I think that TD_THIS_FILE is only relevant for that once example.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants