Updated an FAQ

[Nandhini4501]

Updated an FAQ as per the ticket https://testsigma.atlassian.net/browse/DOC-432

Summary by CodeRabbit

• Documentation
  • Updated API documentation with parameterized URL examples for better clarity.
  • Added visual example of execution results to the API guide.
  • Corrected step numbering in installation guides for improved readability.
  • Updated image references in terminal installation instructions for consistency.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

Walkthrough

Documentation updates across FAQ and installation guides: API URL parameters and example added to Excel upload FAQ, installation steps renumbered in Linux and Windows guides, and image file paths updated in the terminal installation guide.

Changes

Cohort / File(s)	Change Summary
FAQ API Reference Update src/pages/docs/FAQs/general/how-to-update-an-excel-file-in-testsigma-uploads.md	Updated API URL from static endpoint to parameterized format with {ID} placeholder; added concrete example (e.g., /uploads/8); introduced new "After you execute it, here's how it looks" section with image.
Installation Guide Step Renumbering src/pages/docs/live-editor/installing-testsigma-terminal-on-linux.md, src/pages/docs/live-editor/installing-testsigma-terminal-on-windows.md	Renumbered steps in Linux guide (1–2 → 9–10) and Windows troubleshooting steps (1–2 → 5–6); cosmetic adjustments to step numbering only.
Installation Guide Image Path Updates src/pages/docs/live-editor/installing-testsigma-terminal.md	Updated image file references: Terminal\_3.png → live\_editor/install\_terminal\_1.png; install\_terminal\_1.png → live\_editor/terminal\_n\_1.1.png.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

• Verify the parameterized API URL matches the actual backend endpoints and that {ID} placeholder documentation is clear
• Confirm updated image file paths (live\_editor/\.\.\.png) exist and are accessible at the new locations
• Validate step renumbering doesn't create cross-reference inconsistencies with other documentation

Possibly related PRs

• Added a new FAQ to docs #875: Introduces the same FAQ file for updating Excel files in uploads, so this PR updates its content
• Updated the Installing Testsigma Terminal and the FAQ on Testsigma Terminal docs #723: Updates the same terminal installation documentation with image and content modifications
• Updated Components of Testsigma Terminal doc #865: Modifies the same Windows installation file with step renumbering adjustments

Suggested reviewers

• bharathk08

Poem

🐰 Step numbers shift and images align,
URLs now dance with {ID} so fine,
Docs refreshed in spring's design—
Terminal guides now brightly shine!
✨

Pre-merge checks and finishing touches

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Title check	❓ Inconclusive	The title 'Updated an FAQ' is vague and generic, failing to convey meaningful information about the specific changes in this pull request.	Replace with a more specific title that describes the actual changes, such as 'Update Excel file upload API URL and add result image to FAQ' or similar.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch fix/DOC-432

---

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

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

src/pages/docs/live-editor/installing-testsigma-terminal-on-linux.md (1)

47-47: Align text formatting with other guides.

Line 47 has split bold formatting: **Open the desktop** app instead of **Open the desktop app**. The Windows guide (line 36) uses unified bold formatting. Update for consistency:

-9. Click **Open the desktop** app. The **Testsigma Terminal** opens.
+9. Click **Open the desktop app**. The **Testsigma Terminal** opens.

Also applies to: 47-47

📜 Review details

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 95a61f9 and 8f0bdf7.

📒 Files selected for processing (4)

• src/pages/docs/FAQs/general/how-to-update-an-excel-file-in-testsigma-uploads.md (1 hunks)
• src/pages/docs/live-editor/installing-testsigma-terminal-on-linux.md (1 hunks)
• src/pages/docs/live-editor/installing-testsigma-terminal-on-windows.md (1 hunks)
• src/pages/docs/live-editor/installing-testsigma-terminal.md (1 hunks)

🧰 Additional context used

🪛 LanguageTool

src/pages/docs/FAQs/general/how-to-update-an-excel-file-in-testsigma-uploads.md

[style] ~77-~77: Using many exclamation marks might seem excessive (in this case: 6 exclamation marks for a text that’s 3973 characters long)
Context: ...pi key in the testdata placeholder. ![api](https://s3.amazonaws.com/static-do...

(EN_EXCESSIVE_EXCLAMATION)

🔇 Additional comments (4)

src/pages/docs/FAQs/general/how-to-update-an-excel-file-in-testsigma-uploads.md (2)

76-76: API URL parameterization improves clarity with concrete example.

The update from a static URL to a parameterized format with placeholder {ID} and a concrete example (e.g., https://app.testsigma.com/api/v1/uploads/8) significantly clarifies how users should construct the API endpoint. The markdown link syntax is correct, and the instructions to replace the placeholder are explicit.

Verify that the example URL https://app.testsigma.com/api/v1/uploads/8 is syntactically correct and that the image reference ![URL](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/faq/uploads_23.png) points to an accessible asset.

---

82-83: New visual documentation section enhances user experience.

Adding the "After you execute it, here's how it looks:" section with a Run Result screenshot provides concrete visual feedback and sets proper expectations for users following the steps. The section integrates naturally into the workflow documentation.

Verify that the image reference https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/faq/uploads_28.png points to an accessible asset.

src/pages/docs/live-editor/installing-testsigma-terminal-on-windows.md (1)

36-36: Step numbering and formatting look good.

Steps 5-6 are correctly aligned with the main installation guide, and the text formatting is consistent. The renumbering ensures proper sequential flow for the Windows platform guide.

Also applies to: 38-38

src/pages/docs/live-editor/installing-testsigma-terminal.md (1)

83-83: No issues detected. Both S3 image URLs are publicly accessible (HTTP 200) and resolve correctly. The filename terminal_n_1.1.png on line 89, while unconventional in naming, is confirmed to be the intended asset and poses no risk of broken links.