The open alternative to Salesforce, designed for AI.
TypeScript crmcrm-systemcustomergood-first-issuegraphqlhacktoberfestjavascriptmarketingmonoreponestjsopen-sourcepostgresqlreactreactjssalestypescriptweb
docs: fix contributor docs links and typos (#18637)
Sri Hari Haran Sharma70a060b4eea4
diff --git a/.github/workflows/docs-i18n-pull.yaml b/.github/workflows/docs-i18n-pull.yamlindex a071290ddf9..40cd4413b07 100644--- a/.github/workflows/docs-i18n-pull.yaml+++ b/.github/workflows/docs-i18n-pull.yaml@@ -40,7 +40,8 @@ jobs:uses: actions/checkout@v4with:token: ${{ github.token }}- ref: ${{ github.event_name == 'pull_request' && github.head_ref || github.ref }}+ repository: ${{ github.event_name == 'pull_request' && github.event.pull_request.head.repo.full_name || github.repository }}+ ref: ${{ github.event_name == 'pull_request' && github.event.pull_request.head.sha || github.ref }}- name: Install dependenciesuses: ./.github/actions/yarn-install@@ -111,7 +112,7 @@ jobs:run: yarn docs:generate-paths- name: Commit artifacts to pull request branch- if: github.event_name == 'pull_request'+ if: github.event_name == 'pull_request' && github.event.pull_request.head.repo.full_name == github.repositoryrun: |git add packages/twenty-docs/docs.json packages/twenty-docs/navigation/navigation.template.json packages/twenty-shared/src/constants/DocumentationPaths.tsif git diff --staged --quiet --exit-code; then@@ -149,4 +150,3 @@ jobs:fienv:GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}-diff --git a/README.md b/README.mdindex 8f3f02bada9..610c9a2cdab 100644--- a/README.md+++ b/README.md@@ -25,8 +25,8 @@# InstallationSee:-π [Self-hosting](https://docs.twenty.com/developers/self-hosting/docker-compose)-π₯οΈ [Local Setup](https://docs.twenty.com/developers/local-setup)+π [Self-hosting](https://docs.twenty.com/developers/self-host/capabilities/docker-compose)+π₯οΈ [Local Setup](https://docs.twenty.com/developers/contribute/capabilities/local-setup)# Why Twenty@@ -36,7 +36,7 @@ We built Twenty for three reasons:**A fresh start is required to build a better experience.** We can learn from past mistakes and craft a cohesive experience inspired by new UX patterns from tools like Notion, Airtable or Linear.-**We believe in Open-source and community.** Hundreds of developers are already building Twenty together. Once we have plugin capabilities, a whole ecosystem will grow around it.+**We believe in open-source and community.** Hundreds of developers are already building Twenty together. Once we have plugin capabilities, a whole ecosystem will grow around it.<br />diff --git a/packages/twenty-docs/developers/contribute/capabilities/frontend-development/style-guide.mdx b/packages/twenty-docs/developers/contribute/capabilities/frontend-development/style-guide.mdxindex f21ad8e9006..cb5945d1b44 100644--- a/packages/twenty-docs/developers/contribute/capabilities/frontend-development/style-guide.mdx+++ b/packages/twenty-docs/developers/contribute/capabilities/frontend-development/style-guide.mdx@@ -9,7 +9,7 @@ The goal here is to have a consistent codebase, which is easy to read and easy tFor this, it's better to be a bit more verbose than to be too concise.-Always keep in mind that people read code more often than they write it, specially on an open source project, where anyone can contribute.+Always keep in mind that people read code more often than they write it, especially on an open source project, where anyone can contribute.There are a lot of rules that are not defined here, but that are automatically checked by linters.@@ -150,7 +150,7 @@ type MyType = {### Use string literals instead of enums-[String literals](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#literal-types) are the go-to way to handle enum-like values in TypeScript. They are easier to extend with Pick and Omit, and offer a better developer experience, specially with code completion.+[String literals](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#literal-types) are the go-to way to handle enum-like values in TypeScript. They are easier to extend with Pick and Omit, and offer a better developer experience, especially with code completion.You can see why TypeScript recommends avoiding enums [here](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#enums).@@ -288,4 +288,3 @@ An Oxlint rule, `typescript/consistent-type-imports`, enforces the no-type imporPlease note that this rule specifically addresses rare edge cases where unintentional type imports occur. TypeScript itself discourages this practice, as mentioned in the [TypeScript 3.8 release notes](https://www.typescriptlang.org/docs/handbook/release-notes/typescript-3-8.html). In most situations, you should not need to use type-only imports.To ensure your code complies with this rule, make sure to run Oxlint as part of your development workflow.-diff --git a/packages/twenty-docs/developers/contribute/capabilities/local-setup.mdx b/packages/twenty-docs/developers/contribute/capabilities/local-setup.mdxindex 50ec3467a23..22309c334c1 100644--- a/packages/twenty-docs/developers/contribute/capabilities/local-setup.mdx+++ b/packages/twenty-docs/developers/contribute/capabilities/local-setup.mdx@@ -7,7 +7,7 @@ description: "The guide for contributors (or curious developers) who want to run## Prerequisites<Tabs>-<Tab title="Linux and MacOS">+<Tab title="Linux and macOS">Before you can install and use Twenty, make sure you install the following on your computer:- [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)@@ -31,7 +31,7 @@ wsl --install```You should now see a prompt to restart your computer. If not, restart it manually.-Upon restart, a powershell window will open and install Ubuntu. This may take up some time.+Upon restart, a PowerShell window will open and install Ubuntu. This may take up some time.You'll see a prompt to create a username and password for your Ubuntu installation.2. Install and configure git@@ -104,7 +104,7 @@ You should run all commands in the following steps from the root of the project.<Tabs><Tab title="Linux">**Option 1 (preferred):** To provision your database locally:- Use the following link to install Postgresql on your Linux machine: [Postgresql Installation](https://www.postgresql.org/download/linux/)+ Use the following link to install PostgreSQL on your Linux machine: [PostgreSQL Installation](https://www.postgresql.org/download/linux/)```bashpsql postgres -c "CREATE DATABASE \"default\";" -c "CREATE DATABASE test;"```@@ -131,7 +131,7 @@ You should run all commands in the following steps from the root of the project.```The installer might not create the `postgres` user by default when installing- via Homebrew on MacOS. Instead, it creates a PostgreSQL role that matches your macOS+ via Homebrew on macOS. Instead, it creates a PostgreSQL role that matches your macOSusername (e.g., "john").To check and create the `postgres` user if necessary, follow these steps:```bash@@ -174,8 +174,8 @@ You should run all commands in the following steps from the root of the project.<Tab title="Windows (WSL)">All the following steps are to be run in the WSL terminal (within your virtual machine)- **Option 1:** To provision your Postgresql locally:- Use the following link to install Postgresql on your Linux virtual machine: [Postgresql Installation](https://www.postgresql.org/download/linux/)+ **Option 1:** To provision your PostgreSQL locally:+ Use the following link to install PostgreSQL on your Linux virtual machine: [PostgreSQL Installation](https://www.postgresql.org/download/linux/)```bashpsql postgres -c "CREATE DATABASE \"default\";" -c "CREATE DATABASE test;"```@@ -190,10 +190,12 @@ You should run all commands in the following steps from the root of the project.</Tab></Tabs>-You can now access the database at [localhost:5432](localhost:5432), with user `postgres` and password `postgres` .+You can now access the database at `localhost:5432`.++If you used the Docker option above, the default credentials are user `postgres` and password `postgres`. For native PostgreSQL installations, use the credentials and roles configured on your machine.## Step 4: Set up a Redis Database (cache)-Twenty requires a redis cache to provide the best performance+Twenty requires a Redis cache to provide the best performance.<Tabs><Tab title="Linux">@@ -210,8 +212,10 @@ Twenty requires a redis cache to provide the best performance```bashbrew install redis```- Start your redis server:- ```brew services start redis```+ Start your Redis server:+ ```bash+ brew services start redis+ ```**Option 2:** If you have docker installed:```bash@@ -229,11 +233,11 @@ Twenty requires a redis cache to provide the best performance</Tab></Tabs>-If you need a Client GUI, we recommend [redis insight](https://redis.io/insight/) (free version available)+If you need a client GUI, we recommend [Redis Insight](https://redis.io/insight/) (free version available).-## Step 5: Setup environment variables+## Step 5: Set up environment variables-Use environment variables or `.env` files to configure your project. More info [here](/developers/self-host/capabilities/setup)+Use environment variables or `.env` files to configure your project. More info [here](/developers/self-host/capabilities/setup).Copy the `.env.example` files in `/front` and `/server`:```bashdiff --git a/packages/twenty-docs/developers/self-host/capabilities/docker-compose.mdx b/packages/twenty-docs/developers/self-host/capabilities/docker-compose.mdxindex 3cd7bb1381d..dc098a33b3c 100644--- a/packages/twenty-docs/developers/self-host/capabilities/docker-compose.mdx+++ b/packages/twenty-docs/developers/self-host/capabilities/docker-compose.mdx@@ -4,7 +4,7 @@ title: 1-Click w/ Docker Compose<Warning>-Docker containers are for production hosting or self-hosting, for the contribution please check the [Local Setup](/developers/contribute/capabilities/local-setup).+Docker containers are for production hosting or self-hosting. For contributing, please check the [Local Setup](/developers/contribute/capabilities/local-setup).</Warning>## Overview@@ -13,7 +13,7 @@ This guide provides step-by-step instructions to install and configure the Twent**Important:** Only modify settings explicitly mentioned in this guide. Altering other configurations may lead to issues.-See docs [Setup Environment Variables](/developers/self-host/capabilities/setup) for advanced configuration. All environment variables must be declared in the docker-compose.yml file at the server and / or worker level depending on the variable.+See [Setup Environment Variables](/developers/self-host/capabilities/setup) for advanced configuration. All environment variables must be declared in the `docker-compose.yml` file at the server and/or worker level, depending on the variable.## System Requirements@@ -237,4 +237,3 @@ docker compose up -dIf you encounter any problem, check [Troubleshooting](/developers/self-host/capabilities/troubleshooting) for solutions.-