Updated Upload Apps & Audit Logs docs#1043
Conversation
📝 WalkthroughWalkthroughThis 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. ChangesDocumentation Content Updates
Estimated code review effort: 1 (Trivial) | ~3 minutes Possibly related PRs
Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
There was a problem hiding this comment.
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
📒 Files selected for processing (2)
src/pages/docs/activity-monitoring/audit-logs.mdsrc/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. |
There was a problem hiding this comment.
🎯 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.
| > 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.
Summary by CodeRabbit