docs(setup): replace NX with Turbo in setup instructions

[voi-jankowski]

User description

Description

This update modifies the project's setup documentation to replace the outdated NX setup instructions with the new Turbo setup instructions. This change reflects our shift to using Turbo for monorepo management, aligning the documentation with our current development practices.

Fixes #174

Dependencies

• No new dependencies introduced. The change is in documentation only.

Mentions

@rajdip-b

Changes Walkthrough

Relevant Files:

	Relevant Files
Documentation	##setting-things-up.md replace NX with Turbo in setup instructions docs/contributing-to-keyshade/setting-things-up.md Removed references to installing NX as the monorepo management tool. Added new section detailing the installation process for Turbo, including global installation via npm. +1/-1

Developer's checklist

• [✅] My PR follows the style guidelines of this project
• [✅] I have performed a self-check on my work

If changes are made in the code:

• I have followed the coding guidelines
• My changes in code generate no new warnings
• My changes are breaking another fix/feature of the project
• I have added test cases to show that my feature works
• I have added relevant screenshots in my PR
• There are no UI/UX issues

Documentation Update

• [✅] This PR requires an update to the documentation at docs.keyshade.xyz
• [✅] I have made the necessary updates to the documentation, or no documentation changes are required.

---

Type

Documentation

---

Description

• Updated the setup documentation to replace NX with Turbo as the monorepo management tool.
• Provided the command for global installation of Turbo.
• Added a link to the official Turbo documentation for further reading.

---

Changes walkthrough

	Relevant files
Documentation	setting-things-up.md Update Setup Instructions to Use Turbo                                      docs/contributing-to-keyshade/setting-things-up.md Replaced NX installation instructions with Turbo. Added a command for installing Turbo globally. Included a reference to the official Turbo documentation. +5/-3

---

✨ PR-Agent usage:
Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

[codiumai-pr-agent-free]

PR Description updated to latest commit (bb751dd)

[sonarcloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarCloud

[codiumai-pr-agent-free]

PR Review

⏱️ Estimated effort to review [1-5]	1, because the PR involves straightforward documentation updates with clear instructions on replacing NX with Turbo for monorepo management. The changes are concise and focused solely on the setup instructions, making it easy to review.
🧪 Relevant tests	No
🔍 Possible issues	No
🔒 Security concerns	No

---

✨ Review tool usage guide:

---

Overview:
The review tool scans the PR code changes, and generates a PR review which includes several types of feedbacks, such as possible PR issues, security threats and relevant test in the PR. More feedbacks can be added by configuring the tool.

The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on any PR.

• When commenting, to edit configurations related to the review tool (pr_reviewer section), use the following template:

/review --pr_reviewer.some_config1=... --pr_reviewer.some_config2=...

• With a configuration file, use the following template:

[pr_reviewer]
some_config1=...
some_config2=...

See the review usage page for a comprehensive guide on using this tool.

[codiumai-pr-agent-free]

PR Code Suggestions

Category	Suggestions
Enhancement	Add rationale for transitioning from NX to Turbo. Consider adding a brief explanation or rationale for the transition from NX to Turbo. This can help contributors understand the decision-making process and the benefits of using Turbo over NX. docs/contributing-to-keyshade/setting-things-up.md [45-47] ## Installing Turbo -The final step involves installing our monorepo management tool. We have transitioned to using Turbo to streamline our development process. To install Turbo, run the following command: +The final step involves installing our monorepo management tool. We have transitioned to using Turbo from NX to streamline our development process, due to its faster build times and more efficient handling of monorepo dependencies. To install Turbo, run the following command:
	Specify the environment for running commands. To ensure clarity and consistency, consider specifying the command line interface (CLI) or terminal as the environment for running the provided commands, especially for contributors who might be less familiar with development environments. docs/contributing-to-keyshade/setting-things-up.md [42] -To install the dependencies, run the following command: +To install the dependencies, open your command line interface (CLI) or terminal and run the following command:
	Add a description for the external Turbo documentation link. For better accessibility and to assist users who might face issues while navigating external links, consider adding a brief description of what users can expect to find in the Turbo documentation link provided. docs/contributing-to-keyshade/setting-things-up.md [53] -For more information on how to get started with Turbo, refer to the [official Turbo documentation](https://turbo.build/repo/docs). +For more information on how to get started with Turbo, including setup guides, best practices, and troubleshooting, refer to the [official Turbo documentation](https://turbo.build/repo/docs).
Best practice	Use consistent package manager for global installations. It's recommended to use the same package manager consistently across the project documentation. Since pnpm is used for installing dependencies initially, consider using pnpm for installing Turbo globally as well, if supported. docs/contributing-to-keyshade/setting-things-up.md [50] ```bash -npm install turbo --global +pnpm add --global turbo </details></td></tr><tr><td rowspan=1><strong>Maintainability</strong></td> <td> <details><summary>Use a more formal tone in the instructions.</summary> ___ **To maintain a consistent and professional tone throughout the document, consider using a <br>more formal tone in the instructions. For example, instead of "you would need," use "you <br>will need."** [docs/contributing-to-keyshade/setting-things-up.md [57]](https://github.com/keyshade-xyz/keyshade/pull/175/files#diff-cef348a8823f15a58b87562625cba74999f427c52980164863ee234f45897d44R57-R57) ```diff -If you plan to work on the API, you would need the **NestJS CLI.** To do this, simply run: +If you plan to work on the API, you will need the **NestJS CLI.** To install it, run the following command:

---

✨ Improve tool usage guide:

---

Overview:
The improve tool scans the PR code changes, and automatically generates suggestions for improving the PR code. The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on a PR.

• When commenting, to edit configurations related to the improve tool (pr_code_suggestions section), use the following template:

/improve --pr_code_suggestions.some_config1=... --pr_code_suggestions.some_config2=...

• With a configuration file, use the following template:

[pr_code_suggestions]
some_config1=...
some_config2=...

See the improve usage page for a comprehensive guide on using this tool.

[rajdip-b]

Looks perfect! Thanks @voi-jankowski <3

[rajdip-b]

🎉 This PR is included in version 1.3.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀