Develop

.github/workflows/docs.yml

@@ -24,23 +24,21 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v4
 
-      - name: Setup Python
-        uses: actions/setup-python@v4
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
         with:
-          python-version: '3.10'
-
-      - name: Install dependencies
-        run: |
-          python -m pip install --upgrade pip
-          pip install jekyll jekyll-seo-tag jekyll-sitemap
+          ruby-version: '3.2' # Puedes usar otra versión si lo deseas
+          bundler-cache: true
+          working-directory: docs
 
       - name: Setup Pages
         uses: actions/configure-pages@v4
+        id: page-setup
 
       - name: Build with Jekyll
         run: |
           cd docs
-          jekyll build --baseurl "${{ steps.page-setup.outputs.base_path }}"
+          bundle exec jekyll build --baseurl "${{ steps.page-setup.outputs.base_path }}"
         env:
           JEKYLL_ENV: production
 
@@ -59,4 +57,4 @@ jobs:
     steps:
       - name: Deploy to GitHub Pages
         id: deployment
-        uses: actions/deploy-pages@v4 
+        uses: actions/deploy-pages@v4

.gitignore

@@ -69,8 +69,10 @@ instance/
 # Scrapy stuff:
 .scrapy
 
-# Sphinx documentation
+# Documentation
 docs/_build/
+docs/_site/
+/site
 
 # PyBuilder
 .pybuilder/
@@ -137,9 +139,6 @@ venv.bak/
 # Rope project settings
 .ropeproject
 
-# mkdocs documentation
-/site
-
 # mypy
 .mypy_cache/
 .dmypy.json
@@ -160,3 +159,4 @@ cython_debug/
 #  and can be added to the global gitignore or merged into this file.  For a more nuclear
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
 #.idea/
+

DOCUMENTATION_SETUP.md

@@ -156,7 +156,7 @@ Edit `docs/_config.yml` to customize:
 # Site information
 title: "Alanube Python API Documentation"
 description: "Comprehensive documentation for the Alanube Python API client"
-url: "https://wilmerm.github.io/alanube-python-api"
+url: "https://wilmerm.github.io/alanube-python"
 
 # Navigation
 nav:
@@ -167,8 +167,8 @@ nav:
 
 # Social links
 social:
-  github: wilmerm/alanube-python-api
-  twitter: alanube_co
+  github: wilmerm/alanube-python
+  twitter: AlanubeRD
 ```
 
 ## 🔧 Deployment
@@ -180,7 +180,7 @@ The documentation is automatically deployed via GitHub Actions:
 1. **Trigger:** Push to main/master branch
 2. **Build:** Jekyll builds the site
 3. **Deploy:** Site is deployed to GitHub Pages
-4. **URL:** https://wilmerm.github.io/alanube-python-api
+4. **URL:** https://wilmerm.github.io/alanube-python/
 
 ### Manual Deployment
 
@@ -241,7 +241,7 @@ The site includes:
    ```bash
    # Check Jekyll version
    jekyll --version
-   
+
    # Clean and rebuild
    bundle exec jekyll clean
    bundle exec jekyll build
@@ -382,4 +382,4 @@ This documentation is licensed under the MIT License, same as the main project.
 
 **The documentation is now ready to help users effectively use the Alanube Python API! 🚀**
 
-For questions or improvements, please open an issue or submit a pull request. 
+For questions or improvements, please open an issue or submit a pull request.

README.md

@@ -73,8 +73,8 @@ If you're contributing to the development of this library, here are the steps to
 1. Clone the repository:
 
     ```sh
-    git clone https://github.com/wilmerm/alanube-python-api.git
-    cd alanube-python-api
+    git clone https://github.com/wilmerm/alanube-python.git
+    cd alanube-python
     ```
 
 2. Create a virtual environment (optional but recommended):
@@ -147,15 +147,22 @@ To compile and upload the library to PyPI, follow these steps:
 ## Credits
 
 <table>
-  <tr>
-    <td align="center">
-      <a href="https://github.com/wilmerm">
-        <img src="https://github.com/wilmerm.png" width="100px;" alt="Wilmer Martinez"/><br />
-        <sub><b>Wilmer Martinez</b></sub>
-      </a>
-      <br/>Author & Maintainer
-    </td>
-  </tr>
+    <tr>
+        <td align="center">
+            <a href="https://github.com/wilmerm">
+                <img src="https://github.com/wilmerm.png" width="100px;" alt="Wilmer Martinez"/><br />
+                <sub><b>Wilmer Martinez</b></sub>
+            </a>
+            <br/>Author & Maintainer
+        </td>
+        <td align="center">
+            <a href="https://github.com/Bamidele123456">
+                <img src="https://github.com/Bamidele123456.png" width="100px;" alt="Oriku Precious"/><br />
+                <sub><b>Oriku Precious</b></sub>
+            </a>
+            <br/>Documentation Contributor
+        </td>
+    </tr>
 </table>
 
 If you contributed to this project and would like to be listed here, feel free to open a pull request adding yourself to the credits section.
@@ -175,9 +182,7 @@ We welcome pull requests and suggestions. Please open an issue or submit a PR.
 
 ## Support 💗
 
-If you find this useful, consider supporting:
-
-[Donate on PayPal](https://paypal.me/martinezwilmer?country.x=DO&locale.x=es_XC)
+If you find this useful, consider supporting.
 
 Your generosity helps us to continue improving and maintaining this project. We appreciate every contribution, however small. Thanks for being part of our community!
 

docs/_config.yml

@@ -1,11 +1,11 @@
 title: Alanube Python API Documentation
 description: Comprehensive documentation for the Alanube Python API client
 author: Alanube Team
-email: support@alanube.co
+email: soporte@alanube.co
 
 # Site settings
-url: "https://wilmerm.github.io/alanube-python-api"
-baseurl: "/alanube-python-api"
+url: "https://wilmerm.github.io/alanube-python/"
+baseurl: "/alanube-python"
 
 # Build settings
 markdown: kramdown
@@ -50,18 +50,18 @@ nav:
 footer:
   links:
     - title: GitHub
-      url: https://github.com/wilmerm/alanube-python-api
+      url: https://github.com/wilmerm/alanube-python
     - title: PyPI
       url: https://pypi.org/project/alanube/
     - title: Issues
-      url: https://github.com/wilmerm/alanube-python-api/issues
+      url: https://github.com/wilmerm/alanube-python/issues
     - title: Alanube
       url: https://www.alanube.co/
 
 # Social media
 social:
-  github: wilmerm/alanube-python-api
-  twitter: alanube_co
+  github: wilmerm/alanube-python
+  twitter: AlanubeRD
 
 # Analytics (optional)
 # google_analytics: UA-XXXXXXXXX-X
@@ -82,4 +82,4 @@ exclude:
   - setup.cfg
   - MANIFEST.in
   - alanube/
-  - .gitignore 
+  - .gitignore