chore: simplify local run commands

Author: dreamorosi

CONTRIBUTING.md

@@ -120,42 +120,29 @@ You might find useful to run both the documentation website and the API referenc
 1. Build the Docker image (only needed the first time):
 
    ```bash
-   npm run docs-buildDockerImage
+   npm run docs:docker:build
    ```
 
 2. Run the documentation website:
 
    ```bash
-   npm run docs-runLocalDocker
+   npm run docs:docker:run
    ```
 
 #### Using Python directly
 
-If you have Python installed, you can run the documentation website and API reference locally without Docker:
+If you have Python 3.x installed, you can run the documentation website and API reference locally without Docker:
 
-1. Create a virtual environment:
+1. Create a virtual environment and install dependencies:
 
    ```bash
-   python3 -m venv .venv
+   npm run docs:local:setup
    ```
 
-2. Activate the virtual environment:
-
-   ```bash
-   source .venv/bin/activate # Linux/Mac
-   .venv\Scripts\activate # Windows
-   ```
-
-3. Install the required dependencies:
-
-   ```bash
-   pip install -r docs/requirements.txt
-   ```
-
-4. Run the documentation website:
+2. Run the documentation website:
 
    ```bash
-   mkdocs serve
+   npm run docs:local:run
    ```
 
 ## Conventions

docs/contributing/setup.md

@@ -74,40 +74,27 @@ You might find useful to run both the documentation website and the API referenc
 1. Build the Docker image (only needed the first time):
 
    ```bash
-   npm run docs-buildDockerImage
+   npm run docs:docker:build
    ```
 
 2. Run the documentation website:
 
    ```bash
-   npm run docs-runLocalDocker
+   npm run docs:docker:run
    ```
 
 #### Using Python directly
 
 If you have Python installed, you can run the documentation website and API reference locally without Docker:
 
-1. Create a virtual environment:
+1. Create a virtual environment and install dependencies:
 
    ```bash
-   python3 -m venv .venv
+   npm run docs:local:setup
    ```
 
-2. Activate the virtual environment:
-
-   ```bash
-   source .venv/bin/activate # Linux/Mac
-   .venv\Scripts\activate # Windows
-   ```
-
-3. Install the required dependencies:
-
-   ```bash
-   pip install -r docs/requirements.txt
-   ```
-
-4. Run the documentation website:
+2. Run the documentation website:
 
    ```bash
-   mkdocs serve
+   npm run docs:local:run
    ```

mkdocs.yml

@@ -141,7 +141,7 @@ plugins:
       output_dir: 'api'
       tsconfig: 'tsconfig.json'
       options: 'typedoc.json'
-      name: 'API Docs'
+      name: 'API Reference'
 
 extra_css:
   - stylesheets/extra.css

package.json

@@ -27,12 +27,11 @@
     "commit": "commit",
     "setup-local": "npm ci && npm run build && husky",
     "build": "npm run build -ws",
-    "docs-website-build-run": "npm run docs-buildDockerImage && npm run docs-runLocalDocker",
-    "docs-buildDockerImage": "docker build -t powertools-typescript/docs ./docs/",
-    "docs-runLocalDocker": "docker run --rm -it -p 8000:8000 -v ${PWD}:/docs powertools-typescript/docs",
-    "docs-api-build-run": "npm run docs-generateApiDoc && npx live-server api",
-    "docs-generateApiDoc": "typedoc .",
-    "docs-runLocalApiDoc": "npx live-server api",
+    "docs:docker:build": "docker build -t powertools-typescript/docs ./docs/",
+    "docs:docker:run": "docker run --rm -it -p 8000:8000 -v ${PWD}:/docs powertools-typescript/docs",
+    "docs:local:setup": "python3 -m venv .venv && .venv/bin/pip install -r docs/requirements.txt",
+    "docs:local:run": ".venv/bin/mkdocs serve",
+    "docs:local:api": "typedoc .",
     "postpublish": "git restore .",
     "lint:markdown": "markdownlint-cli2 '**/*.md' '#node_modules' '#**/*/node_modules' '#docs/changelog.md' '#LICENSE.md' '#.github' '#**/*/CHANGELOG.md' '#examples/app/README.md'"
   },