refactor: Remove project key references from documentation and update test tool descriptions for clarity

Author: hasanalituran

docs/ci-integrations/setup.md

@@ -9,7 +9,6 @@ Upload CTRF test reports to Testream from any CI provider. Use the GitHub Action
 ## What you need
 
 - **Testream API key** (from testream.app → Settings → API Keys)
-- **Jira project key** (e.g., `PROJ`)
 - A **CTRF report** (generated by the Playwright or .NET reporter)
 
 ## GitHub Actions (Action)
@@ -39,7 +38,6 @@ jobs:
         uses: testream/upload-action@v0.4.1
         with:
           report-path: ctrf/ctrf-report.json
-          project-key: ${{ secrets.TESTREAM_PROJECT_KEY }}
           api-key: ${{ secrets.TESTREAM_API_KEY }}
 ```
 
@@ -48,8 +46,8 @@ jobs:
 | Input | Required | Default | Description |
 | --- | --- | --- | --- |
 | `report-path` | Yes | - | Path to CTRF report JSON file |
-| `project-key` | Yes | - | Jira project key (e.g., `PROJ`) |
 | `api-key` | Yes* | - | Testream API key (*required unless `no-upload` is true) |
+| `test-tool` | Yes | - | Test tool name (e.g., `playwright`, `jest`, `cypress`, `dotnet`) |
 | `branch` | No | auto | Git branch name |
 | `commit-sha` | No | auto | Git commit SHA |
 | `repository-url` | No | auto | Git repository URL |
@@ -60,7 +58,6 @@ jobs:
 | `app-name` | No | - | Application name |
 | `app-version` | No | - | Application version |
 | `test-type` | No | - | Test type (e.g., `unit`, `e2e`) |
-| `test-tool` | No | - | Override tool name in CTRF report |
 | `no-upload` | No | `false` | Skip upload (validate + summarize only) |
 | `fail-on-error` | No | `true` | Fail the action if upload fails |
 
@@ -71,17 +68,17 @@ Use the CLI in CircleCI, Bitbucket Pipelines, GitLab, Jenkins, Azure Pipelines,
 ```bash
 npx @testream/upload-action \
   --report-path ctrf/ctrf-report.json \
-  --project-key PROJ \
+  --test-tool playwright \
   --api-key $TESTREAM_API_KEY
 ```
 
 ### CLI options
 
 | Option | Description |
 | --- | --- |
-| `-r, --report-path <path>` | Path to CTRF report JSON file |
-| `-p, --project-key <key>` | Jira project key |
-| `-k, --api-key <key>` | API key for authentication |
+| `-r, --report-path <path>` | **Required** Path to CTRF report JSON file |
+| `-k, --api-key <key>` | **Required** API key for authentication |
+| `--test-tool <name>` | **Required** Test tool name (e.g., `playwright`, `jest`, `cypress`, `dotnet`) |
 | `-b, --branch <name>` | Git branch name |
 | `-c, --commit-sha <sha>` | Git commit SHA |
 | `-u, --repository-url <url>` | Git repository URL |
@@ -92,7 +89,6 @@ npx @testream/upload-action \
 | `--app-name <name>` | Application name |
 | `--app-version <ver>` | Application version |
 | `--test-type <type>` | Test type (e.g., `unit`, `e2e`) |
-| `--test-tool <name>` | Override tool name in CTRF report |
 | `--no-upload` | Skip uploading (validate + summarize only) |
 | `--fail-on-error` | Exit with non-zero code if upload fails |
 
@@ -114,7 +110,7 @@ jobs:
           command: |
             npx @testream/upload-action \
               --report-path ctrf/ctrf-report.json \
-              --project-key $TESTREAM_PROJECT_KEY \
+              --test-tool playwright \
               --api-key $TESTREAM_API_KEY \
               --branch $CIRCLE_BRANCH \
               --commit-sha $CIRCLE_SHA1 \
@@ -139,7 +135,7 @@ pipelines:
           - |
             npx @testream/upload-action \
               --report-path ctrf/ctrf-report.json \
-              --project-key $TESTREAM_PROJECT_KEY \
+              --test-tool playwright \
               --api-key $TESTREAM_API_KEY \
               --branch $BITBUCKET_BRANCH \
               --commit-sha $BITBUCKET_COMMIT \

docs/getting-started/installation.md

@@ -8,7 +8,7 @@ Choose the reporter that matches your testing framework and follow the installat
 
 ## Playwright Reporter
 
-Install the Playwright reporter for automatic CTRF report generation and upload.
+Install the Playwright reporter for automatically uploading your Playwright test results.
 
 ```bash
 npm install --save-dev @testream/playwright-reporter
@@ -30,7 +30,7 @@ pnpm add --save-dev @testream/playwright-reporter
 
 ## Cypress Reporter
 
-Install the Cypress reporter for automatic CTRF report generation and upload.
+Install the Cypress reporter for automatically uploading your Cypress test results.
 
 ```bash
 npm install --save-dev @testream/cypress-reporter cypress-ctrf-json-reporter
@@ -52,7 +52,7 @@ pnpm add --save-dev @testream/cypress-reporter cypress-ctrf-json-reporter
 
 ## Jest Reporter
 
-Install the Jest reporter for automatic CTRF report generation and upload.
+Install the Jest reporter for automatically uploading your Jest test results.
 
 ```bash
 npm install --save-dev @testream/jest-reporter
@@ -74,7 +74,7 @@ pnpm add --save-dev @testream/jest-reporter
 
 ## .NET Reporter
 
-Install the .NET reporter CLI globally for converting .NET test results to CTRF format.
+Install the .NET reporter CLI globally for seamlessly uploading your .NET test results.
 
 ```bash
 npm install -g @testream/dotnet-reporter
@@ -118,9 +118,9 @@ You'll need a Testream API key to upload test results.
 
 1. Visit [testream.app](https://testream.app)
 2. Sign up or log in to your account
-3. Navigate to Settings → API Keys
+3. Navigate to Dashboard → Projects
 4. Create a new API key
-5. Copy and store it securely (e.g., GitHub Secrets, environment variables)
+5. Copy and store it securely (e.g., GitHub Secrets, Key Vaults,environment variables)
 
 ---
 

docs/getting-started/quick-start.md

@@ -36,7 +36,6 @@ export default defineConfig({
   reporter: [
     ['@testream/playwright-reporter', {
       apiKey: process.env.TESTREAM_API_KEY,
-      projectKey: 'PROJ',
       uploadEnabled: true,
     }],
 
@@ -142,7 +141,7 @@ You can also run tests first and upload results separately using the GitHub Acti
   run: |
     npx @testream/upload-action \
       --report-path ctrf/ctrf-report.json \
-      --project-key PROJ \
+      --test-tool playwright \
       --api-key ${{ secrets.TESTREAM_API_KEY }}
 ```
 

docs/intro.md

@@ -39,16 +39,16 @@ Upload test results and artifacts with minimal configuration:
 - uses: testream/upload-action@v0.4.1
   with:
     report-path: ctrf/ctrf-report.json
-    project-key: ${{ secrets.TESTREAM_PROJECT_KEY }}
+    test-tool: playwright
     api-key: ${{ secrets.TESTREAM_API_KEY }}
 ```
 
 Or use the CLI directly:
 
 ```bash
-npx @testream/upload-action \\
-  --report-path ctrf/ctrf-report.json \\
-  --project-key PROJ \\
+npx @testream/upload-action \
+  --report-path ctrf/ctrf-report.json \
+  --test-tool playwright \
   --api-key $TESTREAM_API_KEY
 ```
 

docs/jira-integration/usage.md

@@ -167,25 +167,6 @@ Monitor key metrics:
 - **Failure Trends** - Number of failing tests over time
 - **New Failures** - Recently broken tests
 
-## Notifications
-
-Stay informed about test results:
-
-### Jira Notifications
-
-- Test failures on linked issues
-- New test runs completed
-- Flaky test alerts
-
-### Email Notifications
-
-Configure in Testream dashboard:
-1. Go to Settings → Notifications
-2. Enable email alerts for:
-   - Test failures
-   - Flaky tests detected
-   - Daily/weekly summaries
-
 ## Best Practices
 
 ### Issue Linking
@@ -230,58 +211,6 @@ Configure in Testream dashboard:
 
 By default, anyone with access to the Jira issue can view test results.
 
-### Who Can Link Tests?
-
-- Project administrators
-- Users with "Edit Issues" permission
-- Testream account owners
-
-### Configuring Permissions
-
-1. Go to Jira **Settings** → **Apps** → **Testream**
-2. Click **"Permissions"**
-3. Configure:
-   - Who can view test results
-   - Who can link/unlink tests
-   - Who can configure settings
-
-## Troubleshooting
-
-### No test results appearing
-
-**Check:**
-- Tests are actually being uploaded to Testream
-- Issue key is correctly referenced in commits/branches
-- Testream app is connected to your account
-- Jira issue is in the correct project
-
-### Artifacts not loading
-
-**Possible causes:**
-- Artifacts not uploaded with test results
-- Network issues
-- Artifacts expired (check retention policy)
-
-**Solution:**
-- Verify `uploadArtifacts: true` in reporter config
-- Check artifact file sizes (large files may take time)
-- Contact support if artifacts are missing
-
-### Test runs not updating
-
-**Try:**
-- Refresh the page
-- Check if test runs are completing in Testream dashboard
-- Verify webhook connections in settings
-
-### Slow performance
-
-**Solutions:**
-- Reduce date range in filters
-- Limit number of displayed test runs
-- Clear browser cache
-- Check Jira instance performance
-
 ## Getting Help
 
 If you encounter issues:

docs/reporters/cypress.md

@@ -19,13 +19,13 @@ npm install --save-dev @testream/cypress-reporter cypress-ctrf-json-reporter
 The easiest way to get started is using the CLI:
 
 ```bash
-npx @testream/cypress-reporter -p PROJ -k $TESTREAM_API_KEY
+npx @testream/cypress-reporter -k $TESTREAM_API_KEY
 ```
 
 This single command will:
 1. Run your Cypress tests
 2. Generate a CTRF report automatically
-3. Upload results to Testream
+3. Upload results to Testream (project key inferred from API key)
 
 ### Option 2: Programmatic Configuration
 
@@ -41,7 +41,6 @@ export default defineConfig({
       new TestreamReporter({
         on,
         apiKey: process.env.TESTREAM_API_KEY,
-        projectKey: 'PROJ',
         uploadEnabled: true,
       });
     },
@@ -59,7 +58,6 @@ cypress run
 
 | Option | Description |
 | --- | --- |
-| `-p, --project-key` | **Required** Jira project key |
 | `-k, --api-key` | **Required** API key (unless `--no-upload` is used) |
 | `--project <path>` | Path to Cypress project (defaults to current directory) |
 | `--results-path <path>` | Use existing CTRF file(s) instead of running tests |
@@ -85,7 +83,6 @@ When using programmatic configuration, these options are available:
 | --- | --- | --- | --- |
 | `on` | `PluginEvents` | - | **Required** Cypress plugin events object |
 | `apiKey` | `string` | - | **Required** Testream API key |
-| `projectKey` | `string` | - | **Required** Jira project key |
 | `uploadEnabled` | `boolean` | `true` | Enable/disable automatic upload |
 | `failOnUploadError` | `boolean` | `false` | Fail test run if upload fails |
 | `outputDir` | `string` | `ctrf` | CTRF output directory |
@@ -110,34 +107,33 @@ When using programmatic configuration, these options are available:
 ### Run tests and upload
 
 ```bash
-npx @testream/cypress-reporter -p PROJ -k $TESTREAM_API_KEY
+npx @testream/cypress-reporter -k $TESTREAM_API_KEY
 ```
 
 ### Run tests from a specific project directory
 
 ```bash
-npx @testream/cypress-reporter -p PROJ -k $TESTREAM_API_KEY --project ./e2e
+npx @testream/cypress-reporter -k $TESTREAM_API_KEY --project ./e2e
 ```
 
 ### Pass additional arguments to Cypress
 
 ```bash
-npx @testream/cypress-reporter -p PROJ -k $TESTREAM_API_KEY -- --spec "cypress/e2e/**/*.cy.js"
+npx @testream/cypress-reporter -k $TESTREAM_API_KEY -- --spec "cypress/e2e/**/*.cy.js"
 ```
 
 ### Use existing CTRF results
 
 If you've already run your tests and have CTRF reports:
 
 ```bash
-npx @testream/cypress-reporter -p PROJ -k $TESTREAM_API_KEY --results-path ctrf/ctrf-report.json
+npx @testream/cypress-reporter -k $TESTREAM_API_KEY --results-path ctrf/ctrf-report.json
 ```
 
 ### Add full metadata
 
 ```bash
 npx @testream/cypress-reporter \
-  -p PROJ \
   -k $TESTREAM_API_KEY \
   --branch $GITHUB_REF_NAME \
   --commit-sha $GITHUB_SHA \
@@ -167,7 +163,6 @@ export default defineConfig({
         on,
         // API Configuration
         apiKey: process.env.TESTREAM_API_KEY,
-        projectKey: 'PROJ',
 
         // Upload Configuration
         uploadEnabled: true,
@@ -232,10 +227,8 @@ jobs:
       - name: Run Cypress tests and upload
         env:
           TESTREAM_API_KEY: ${{ secrets.TESTREAM_API_KEY }}
-          TESTREAM_PROJECT_KEY: PROJ
         run: |
           npx @testream/cypress-reporter \
-            -p $TESTREAM_PROJECT_KEY \
             -k $TESTREAM_API_KEY \
             --test-environment ci \
             --app-name MyApp \