docs: Minor onboarding clarifications

[cognitivegears]

A couple of minor onboarding clarification updates. When I ran though the process, there were a few small differences in how I needed to run the setup:

The method to copy the environment file only works on bash-like shells. Replacing it with just a general cp command has broader compatibility.

The Algolia setup was slightly different than described. Updated the section based on what I saw during signup.

Fixes Issue: #2570
Checklist

[ X ] I've read and followed the [contributing guidelines](https://github.com/OWASP/Nest/blob/main/CONTRIBUTING.md).
[ X ] I've run make check-test locally; all checks and tests passed.

[coderabbitai]

Summary by CodeRabbit

• Documentation
  • Replaced manual file creation steps with template-copy instructions for environment configuration to simplify setup.
  • Updated integration guidance to reflect auto-created accounts on signup and clarified API permission notes.
  • Consolidated and rephrased setup steps for clearer contributor onboarding without changing the overall flow.

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

Walkthrough

Updates CONTRIBUTING.md to replace manual env file creation with template-based copy commands, revises Algolia setup guidance to reflect automatic app creation on signup and clarified API key permission instructions, and applies minor rephrasing and consolidation across setup steps.

Changes

Cohort / File(s)	Summary
Documentation Updates CONTRIBUTING.md	Replaced touch/cat steps with cp from env templates for backend/.env and frontend/.env; updated Algolia instructions to state apps are auto-created on signup, added note to skip data import, and clarified API key permission guidance; minor wording and step consolidation.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly summarizes the main change: minor onboarding documentation clarifications addressing setup compatibility and Algolia differences.
Description check	✅ Passed	The description is directly related to the changeset, explaining specific motivations for the documentation updates (bash-shell compatibility, Algolia setup differences) and references a fixed issue.
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

---

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.}

[github-actions]

The PR must be linked to an issue assigned to the PR author.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[coderabbitai]

Actionable comments posted: 1

🧹 Nitpick comments (1)

CONTRIBUTING.md (1)

262-263: API key permission note is helpful; minor wording suggestion.

The new guidance about write API key permissions and the addObject requirement is valuable. Consider slightly rewording to make it clearer that this note is specifically about the write API key:

Note: Ensure your write API key has the required index write permissions (addObject permission). If you use a custom write API key instead of the default, verify it has this permission.

This minor clarification emphasizes that the permission requirement applies specifically to the write API key being configured.

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 495e2fc and 6161d71.

📒 Files selected for processing (1)

• CONTRIBUTING.md

🧰 Additional context used

🪛 LanguageTool

CONTRIBUTING.md

[grammar] ~254-~254: Use a hyphen to join words.
Context: ...u when you sign up. - During the sign up process, you may be asked to import d...

(QB_NEW_EN_HYPHEN)

🔇 Additional comments (2)

CONTRIBUTING.md (2)

226-236: Environment file setup is now more portable.

The change from manual file creation to using cp commands is good—it works across all shells rather than being bash-specific, which better serves contributors using different environments.

---

252-260: Algolia setup clarifications improve flow.

The updated guidance now clearly states that an app is automatically created on signup and that data import can be skipped. This directly addresses Issue #2570 and should reduce confusion during setup. The inline note about the write API key is appropriately emphasized.

[arkid15r]

Thanks for improving that @cognitivegears