Update README file

README.md

@@ -1,36 +1,84 @@
-# <img src="assets/svg/safe-logo-white.svg" height="60" valign="middle" alt="Safe{Docs}" />
+# Safe Documentation
 
 [![License](https://img.shields.io/github/license/safe-global/safe-docs)](https://github.com/safe-global/safe-docs/blob/main/LICENSE.md)
 ![GitHub package.json version (branch)](https://img.shields.io/github/package-json/v/safe-global/safe-docs)
-<!-- ![Tests](https://img.shields.io/github/actions/workflow/status/safe-global/safe-docs/test.yml?branch=main&label=tests) -->
 
-# Safe{Docs}
+This repository hosts [Safe](https://safe.global) documentation.
 
-This repository hosts [Safe](https://safe.global)'s documentation website, built with [Nextra](https://nextra.site). Live version can be found at [docs.safe.global](https://docs.safe.global).
+The project is built using [Nextra](https://nextra.site) framework and it can be found live at [docs.safe.global](https://docs.safe.global).
 
-## Quick Start
+## Installation
 
-First, run `pnpm i` to install the dependencies.
+Install the project:
 
-Then, run `pnpm dev` to start the development server and visit `localhost:3000``.
+```
+pnpm install
+```
 
-## Build
+## Development
 
-Run `pnpm build` to build the site. The output will be in the `out` folder.
+Git hooks are set up to run tests and linting checks before every `git push`. These hooks can be executed locally by running the following command:
 
-Run `pnpm start` to serve the site locally.
+```
+pnpm prepush
+```
 
-## Test
+All links in the documentation are checked for validity on every pull request. These checks can be executed locally by running the following command:
 
-Run `pnpm test` to run the tests.
+```
+pnpm linkcheck
+```
+
+## Execution
+
+The project can be run with a server that's executed in development and production mode.
+
+### Development mode
+
+Run the server in development mode:
+
+```
+pnpm dev
+```
+
+### Production mode
+
+Build the project:
+
+```
+pnpm build
+```
+
+Run de server in production mode:
+
+```
+pnpm start
+```
+
+## Testing
+
+Create an environment file in the root of the project and copy the content from the `.env.example` file:
+
+```
+touch .env
+```
+
+```
+NEXT_PUBLIC_HOST_URL='http://localhost:3000'
+NEXT_PUBLIC_GOOGLE_ANALYTICS_TRACKING_ID=
+NEXT_PUBLIC_GOOGLE_ANALYTICS_DOMAIN=
+```
+
+Run the tests:
+
+```
+pnpm test
+```
 
 ## License
 
 This project is licensed under the [MIT License](./LICENSE.md).
 
 ## Contributing
 
-Contributions are welcome! Please open an issue or submit a pull request by following our [contributions guidelines](./CONTRIBUTING.md).
-
-Git hooks are set up to run tests and linting before every push. You can run these hooks locally with `pnpm prepush`. All links will also be checked for validity on every pull request. You can check them locally with `pnpm linkcheck`.
-
+Contributions are more than welcome! Please open an issue or create a pull request by following our [contributions guidelines](./CONTRIBUTING.md).

pages/glossary.md

@@ -89,7 +89,7 @@ See also:
 Safe Apps are web applications that run in the Safe Apps marketplace. They support Safe, use the Safe Apps SDK to interact with it, and aren't owned, controlled, maintained, or audited by Safe.
 
 See also:
-- [Safe Apps SDK documentation](./apps-sdk-overview.md) on docs.safe.global
+- [Safe Apps SDK documentation](./apps-sdk-overview.mdx) on docs.safe.global
 
 ## SafeAuth
 
@@ -105,7 +105,7 @@ See also:
 A Safe Guard is a smart contract that adds restrictions on top of the n-out-of-m scheme that Safe accounts offer. They make checks before and after the execution of a Safe transaction.
 
 See also:
-- [Safe Guards documentation](./smart-account-guards.md) on docs.safe.global
+- [Safe Guards documentation](./smart-account-guards.mdx) on docs.safe.global
 - [Zodiac Guards](https://zodiac.wiki/index.php?title=Category:Guards) on zodiac.wiki
 - [Get the enabled Safe Guard](./sdk-protocol-kit/reference.md#getguard) and [enable a Safe Guard](./sdk-protocol-kit/reference.md#createenableguardtx) with the Safe{Core} SDK on docs.safe.global
 
@@ -114,7 +114,7 @@ See also:
 A Safe Module is a smart contract that adds functionality to Safe while separating module logic from Safe core contracts.
 
 See also:
-- [Safe Modules documentation](./smart-account-modules.md) on docs.safe.global
+- [Safe Modules documentation](./smart-account-modules.mdx) on docs.safe.global
 - [Safe Modules repository](https://github.com/safe-global/safe-modules) on github.com
 - [Zodiac Modules](https://zodiac.wiki/index.php?title=Category:Module) on zodiac.wiki
 - [Get the enabled Safe Modules](./sdk-protocol-kit/reference.md#getmodules) and [enable a Safe Module](./sdk-protocol-kit/reference.md#createenablemoduletx) with the Safe{Core} SDK on docs.safe.global