Skip to content

Updated Upload Apps & Audit Logs docs#1043

Merged
bharathk08 merged 1 commit into
devfrom
DOC-2398
Jul 6, 2026
Merged

Updated Upload Apps & Audit Logs docs#1043
bharathk08 merged 1 commit into
devfrom
DOC-2398

Conversation

@bharathk08

@bharathk08 bharathk08 commented Jul 6, 2026

Copy link
Copy Markdown
Contributor

Summary by CodeRabbit

  • Documentation
    • Clarified audit log guidance by expanding the supported event types shown in log details and filters.
    • Updated the app upload guide with clearer steps for uploading Android and iOS files, including supported upload locations and prerequisites.
    • Improved the upload note to better explain when to start uploads from Android or iOS projects.

@bharathk08
bharathk08 requested a review from Abdul-jailani July 6, 2026 04:44
@coderabbitai

coderabbitai Bot commented Jul 6, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

📝 Walkthrough

Walkthrough

This PR updates two documentation pages: audit-logs.md expands the Event Type entity list to include REST API Step and Step Group in both viewing and filtering sections, and upload-apps.md revises wording around uploading Android/iOS apps, prerequisites, and project-type navigation notes.

Changes

Documentation Content Updates

Layer / File(s) Summary
Audit log Event Type wording
src/pages/docs/activity-monitoring/audit-logs.md
Event Type bullet lists in both "View Audit Logs" and "Filter Audit Logs" sections updated to add REST API Step and Step Group entities with revised authentication wording.
App upload guide wording
src/pages/docs/uploads/upload-apps.md
Reworded upload description, prerequisites for .apk/.ipa files, and NOTE instructions for navigating to correct Android/iOS project before upload.

Estimated code review effort: 1 (Trivial) | ~3 minutes

Possibly related PRs

  • testsigmahq/testsigma-docs#778: Both PRs modify the Event Type list/wording in the "View Audit Logs" and "Filter Audit Logs" sections of audit-logs.md.

Suggested reviewers: Abdul-jailani, Santhosh-testsigma

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the two documentation updates made in Upload Apps and Audit Logs.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch DOC-2398

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@src/pages/docs/uploads/upload-apps.md`:
- Line 35: The prerequisite wording in the upload-apps guide incorrectly implies
both Android and iOS packages are always needed; update the step in the docs so
it refers to the relevant app file only, using conditional language like “APK or
IPA” to match the separate Android and iOS flows described elsewhere in the
page.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 6b063c1d-83b6-4e3e-8908-e9a34a384a9d

📥 Commits

Reviewing files that changed from the base of the PR and between 7401994 and 0473aa4.

📒 Files selected for processing (2)
  • src/pages/docs/activity-monitoring/audit-logs.md
  • src/pages/docs/uploads/upload-apps.md

> 1. [Documentation on creating test cases](https://testsigma.com/docs/test-cases/manage/add-edit-delete/#create-test-case).
> 2. [Documentation on creating projects](https://testsigma.com/docs/projects/overview/).
> 3. Uploadied the **Android** app as a **.apk** file and the **iOS** app as a **.ipa** file for testing.
> 3. Have the Android **.apk** file and iOS **.ipa** file ready.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win

Make the prerequisite conditional on app type.

This reads like both .apk and .ipa are always required, but the rest of the page treats Android and iOS uploads as separate flows. Use “or”/“relevant file” here to avoid misleading readers.

♻️ Proposed fix
-> 3. Have the Android **.apk** file and iOS **.ipa** file ready.
+> 3. Have the relevant Android **.apk** or iOS **.ipa** file ready.
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
> 3. Have the Android **.apk** file and iOS **.ipa** file ready.
> 3. Have the relevant Android **.apk** or iOS **.ipa** file ready.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@src/pages/docs/uploads/upload-apps.md` at line 35, The prerequisite wording
in the upload-apps guide incorrectly implies both Android and iOS packages are
always needed; update the step in the docs so it refers to the relevant app file
only, using conditional language like “APK or IPA” to match the separate Android
and iOS flows described elsewhere in the page.

@bharathk08
bharathk08 merged commit 1ae41b4 into dev Jul 6, 2026
3 of 4 checks passed
bharathk08 added a commit that referenced this pull request Jul 15, 2026
* Updated Upload Apps & Audit Logs docs (#1043)

* Added image to using tunnel document (#1044)

* Updated Azure DevOps doc (#1045)

* Updated Azure DevOps doc

* step edit

* update ms teams document (#1046)
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.

2 participants