### Clone and Install Dependencies (Make) Source: https://github.com/projectalita/projectalita.github.io/blob/main/QUICKSTART.md Clones the ProjectAlita repository and installs all necessary dependencies using make commands. Provides an alternative to shell scripts for setup. This is a one-time setup process. ```bash make validate make install ``` -------------------------------- ### Start Development Servers (Make) Source: https://github.com/projectalita/projectalita.github.io/blob/main/QUICKSTART.md Starts both the landing page and documentation development servers simultaneously using a make command. This is a convenient alternative to shell scripts for initiating development. ```bash make dev ``` -------------------------------- ### Development Quick Start Scripts Source: https://github.com/projectalita/projectalita.github.io/blob/main/MIGRATION.md These bash scripts automate the initial setup and daily development for the unified project. `install-deps.sh` handles dependency installation, while `dev-all.sh` starts both the landing page and documentation development servers simultaneously. ```bash # First time setup ./scripts/install-deps.sh # Daily development ./scripts/dev-all.sh ``` -------------------------------- ### Clone and Install Dependencies (Bash) Source: https://github.com/projectalita/projectalita.github.io/blob/main/QUICKSTART.md Clones the ProjectAlita repository and installs all necessary dependencies using shell scripts. Ensures the development environment is ready. This is a one-time setup process. ```bash git clone https://github.com/ProjectAlita/projectalita.github.io.git cd projectalita.github.io ./scripts/validate-setup.sh ./scripts/install-deps.sh ``` -------------------------------- ### Start Development Servers (Bash) Source: https://github.com/projectalita/projectalita.github.io/blob/main/QUICKSTART.md Starts both the landing page and documentation development servers simultaneously using a shell script. Recommended for full-stack development. Press Ctrl+C to stop. ```bash ./scripts/dev-all.sh ``` -------------------------------- ### Start Documentation Development Server (Make) Source: https://github.com/projectalita/projectalita.github.io/blob/main/QUICKSTART.md Starts only the documentation development server using a make command. Offers a make-based alternative for running the documentation development server. ```bash make dev-docs ``` -------------------------------- ### Initial Setup: Install Dependencies Source: https://github.com/projectalita/projectalita.github.io/blob/main/README.md Installs all project dependencies for both the Next.js landing page and MkDocs documentation using a provided shell script. ```bash # Install all dependencies (Next.js + MkDocs) ./scripts/install-deps.sh ``` -------------------------------- ### Install Dependencies and Start Development Server (npm) Source: https://github.com/projectalita/projectalita.github.io/blob/main/web/README.md Installs project dependencies using npm and starts the development server for the landing page. This command should be run from the landing page's directory. Assumes Node.js 18+ and npm are prerequisites. ```bash # Install dependencies npm install # Start development server npm run dev ``` -------------------------------- ### Start Landing Page Development Server (Make) Source: https://github.com/projectalita/projectalita.github.io/blob/main/QUICKSTART.md Starts only the landing page development server using a make command. Provides an alternative to shell scripts for running the landing page development server. ```bash make dev-landing ``` -------------------------------- ### Start Landing Page Development Server (Bash) Source: https://github.com/projectalita/projectalita.github.io/blob/main/QUICKSTART.md Starts only the landing page development server using a shell script. Useful when focusing solely on the landing page UI or backend. ```bash ./scripts/dev-landing.sh ``` -------------------------------- ### Build All Applications (Bash) Source: https://github.com/projectalita/projectalita.github.io/blob/main/QUICKSTART.md Builds both the landing page and documentation applications using shell scripts. This prepares the project for testing or deployment. ```bash ./scripts/build-all.sh ``` -------------------------------- ### Querying ADO Wiki for Microservices Deployment Summary Source: https://github.com/projectalita/projectalita.github.io/blob/main/docs/how-tos/indexing/index-ado-wiki-data.md This example demonstrates a user request to find and summarize documentation related to microservices deployment from an indexed ADO Wiki. The ADO Wiki Toolkit responds with a detailed summary covering deployment documentation, process steps, key configuration files, and rollback procedures. ```text User Request: "Find all documentation related to microservices deployment and provide a summary of the deployment process from our wiki collection." ADO Wiki Toolkit: "Based on your indexed wiki pages, here's a comprehensive summary of microservices deployment: ... [Detailed summary follows] ... [Citations: Deployment Guide v2.1, Container Best Practices, Production Runbook]" ``` -------------------------------- ### Install MkDocs and Plugins (Python/Bash) Source: https://github.com/projectalita/projectalita.github.io/blob/main/QUICKSTART.md Installs MkDocs, Material theme, and Glightbox plugin using pip. This is a troubleshooting step for 'Command not found: mkdocs' errors. ```bash pip install mkdocs mkdocs-material mkdocs-glightbox ``` -------------------------------- ### Start Documentation Development Server (Bash) Source: https://github.com/projectalita/projectalita.github.io/blob/main/QUICKSTART.md Starts only the documentation development server using a shell script. Ideal for when you are solely working on documentation content or styling. ```bash ./scripts/dev-docs.sh ``` -------------------------------- ### Common Commands Cheatsheet (Make) Source: https://github.com/projectalita/projectalita.github.io/blob/main/QUICKSTART.md A quick reference for common development tasks using make commands, including validation, installation, development, building, and previewing. ```bash make validate make install make dev make dev-landing make dev-docs make build make serve make clean make help ``` -------------------------------- ### Basic Search Configuration Example Source: https://github.com/projectalita/projectalita.github.io/blob/main/docs/how-tos/indexing/using-indexes-tab-interface.md Demonstrates the configuration parameters for performing a basic search using the 'Search Index' tool. This includes setting the query, model, and optional parameters like filters, cutoff, search top, full-text search, extended search, and reranking configuration. ```json { "query": "How do I create secrets in Elitea and what are the best practices for managing sensitive configuration data?", "model_settings": { "model": "gpt-4", "temperature": 0.5 }, "search_params": { "filter": {"file_type": {"$eq": "markdown"}}, "cut_off": 0.7, "search_top": 10, "full_text_search": {"enabled": true, "weight": 0.3, "fields": ["content", "title"], "language": "english"}, "extended_search": ["title", "summary", "propositions", "keywords", "documents"], "reranking_config": {"severity": {"weight": 2.5, "rules": {"priority": "critical"}}} } } ``` -------------------------------- ### Build All Applications (Make) Source: https://github.com/projectalita/projectalita.github.io/blob/main/QUICKSTART.md Builds both the landing page and documentation applications using a make command. This is a common command for preparing the project for production. ```bash make build ``` -------------------------------- ### Create Enhancement Branch (Bash) Source: https://github.com/projectalita/projectalita.github.io/blob/main/DOCUMENTATION.md Example of creating a branch for enhancing existing documentation. The 'enhance/' prefix is used for improving current content with more details or examples. ```bash git checkout -b enhance/improve-getting-started ``` -------------------------------- ### Error Response Example for Confluence Get Page Source: https://github.com/projectalita/projectalita.github.io/blob/main/docs/how-tos/credentials-toolkits/how-to-test-toolkit-tools.md Shows an example of an error response when trying to retrieve a Confluence page. It indicates failure with an error message, error type, and an HTTP status code. ```json ❌ `confluence___get_page` (0.423s) { "success": false, "error": "Page not found with ID: 98765432", "error_type": "PageNotFoundError", "status_code": 404 } ```