docs: add Config Explorer / NeuralNav collaboration analysis and SIG proposal

.dockerignore

@@ -0,0 +1,60 @@
+# Git
+.git
+.gitignore
+.gitattributes
+
+# Python
+__pycache__
+*.py[cod]
+*$py.class
+*.so
+.Python
+*.egg-info
+dist
+build
+.eggs
+
+# Virtual environments
+venv
+.venv
+env
+ENV
+
+# IDE
+.vscode
+.idea
+*.swp
+*.swo
+*~
+.DS_Store
+
+# Testing
+.pytest_cache
+.coverage
+htmlcov
+.tox
+
+# Development
+.ruff_cache
+.mypy_cache
+
+# Generated files
+generated_configs
+logs
+*.log
+
+# Documentation
+*.md
+docs
+!README.md
+
+# Security scan artifacts
+.security-scan
+
+# Kubernetes configs (for development)
+*.kubeconfig
+
+# Other
+TODO.md
+ROADMAP.md
+Makefile

.gitignore

@@ -7,6 +7,7 @@ __pycache__/
 venv/
 env/
 ENV/
+.venv/
 build/
 develop-eggs/
 dist/
@@ -23,6 +24,10 @@ wheels/
 .installed.cfg
 *.egg
 
+# uv
+uv.lock
+.python-version.bak
+
 # IDEs
 .vscode/
 .idea/
@@ -62,4 +67,14 @@ logs/
 
 # Data
 *.sql
-!scripts/schema.sql
+!scripts/schema.sql
+data/benchmarks/performance/benchmarks_GuideLLM.json
+
+# Presentation images (large files, regeneratable)
+data/archive/presentation/
+
+# Old branding (replaced by neuralnav-*)
+docs/ai_assistant_*
+
+# macOS system files (all directories)
+**/.DS_Store

.python-version

@@ -0,0 +1 @@
+3.11

.streamlit/config.toml

@@ -4,10 +4,10 @@ gatherUsageStats = false
 [server]
 headless = true
 port = 8501
+enableStaticServing = true
+
+[client]
+toolbarMode = "viewer"
 
 [theme]
 primaryColor = "#1f77b4"
-backgroundColor = "#FFFFFF"
-secondaryBackgroundColor = "#F0F2F6"
-textColor = "#262730"
-font = "sans serif"

CONTRIBUTING.md

@@ -1,13 +1,12 @@
-# Contributing to Compass
+# Contributing to NeuralNav
 
-Thank you for your interest in contributing to Compass! This document provides guidelines for contributing to the project.
+Thank you for your interest in contributing to NeuralNav! This document provides guidelines for contributing to the project.
 
 ## Table of Contents
 
 - [Code of Conduct](#code-of-conduct)
-- [Getting Started](#getting-started)
-- [Development Workflow](#development-workflow)
-- [Pull Request Guidelines](#pull-request-guidelines)
+- [Recommended Git Workflow](#recommended-git-workflow)
+- [Guidelines](#guidelines)
 - [Commit Message Guidelines](#commit-message-guidelines)
 - [Testing Requirements](#testing-requirements)
 - [Documentation](#documentation)
@@ -17,47 +16,112 @@ Thank you for your interest in contributing to Compass! This document provides g
 
 This project follows standard open source community guidelines. Be respectful, inclusive, and constructive in all interactions.
 
-## Getting Started
+## Recommended Git Workflow
 
-### Setting Up Your Development Environment
+This section describes the complete workflow from setup to submitting a pull request.
 
-1. **Fork the repository** to your own GitHub account
-2. **Clone your fork** locally:
-   ```bash
-   git clone https://github.com/YOUR_USERNAME/compass.git
-   cd compass
-   ```
-3. **Add upstream remote**:
-   ```bash
-   git remote add upstream https://github.com/redhat-et/compass.git
-   ```
-4. **Follow the Quick Start guide** in the [README.md](README.md#quick-start) to set up your environment
+### Initial Setup (One-Time)
 
-## Development Workflow
+**1. Fork the repository** on GitHub to your own account.
 
-### 1. Discuss Before You Code
+**2. Clone your fork locally:**
+```bash
+git clone https://github.com/YOUR_USERNAME/neuralnav.git
+cd neuralnav
+```
+
+**3. Set up remotes:**
+```bash
+# Your fork is already set as 'origin' by the clone
+# Add the main repository as 'upstream'
+git remote add upstream https://github.com/redhat-et/neuralnav.git
+```
+
+Verify your remotes:
+```bash
+git remote -v
+# origin    https://github.com/YOUR_USERNAME/neuralnav.git (fetch)
+# origin    https://github.com/YOUR_USERNAME/neuralnav.git (push)
+# upstream  https://github.com/redhat-et/neuralnav.git (fetch)
+# upstream  https://github.com/redhat-et/neuralnav.git (push)
+```
+
+**4. Set up your development environment** by following the [Quick Start guide](README.md#quick-start).
+
+### Keep Your Main Branch Synchronized
+
+Before starting new work, sync your local main with upstream:
+```bash
+git checkout main
+git fetch upstream
+git rebase upstream/main
+git push origin main    # Keeps your fork's main updated on GitHub
+```
+
+NOTE: Don't make any changes directly on your fork's main branch -- keep it in sync with upstream/main.
+
+### Development Workflow
+
+**1. Create a branch from main:**
+```bash
+git checkout main
+git checkout -b your-feature-name  # branch names like feature/your-feature-name are common but not required.
+git push -u origin your-feature-name
+```
+
+The `-u` flag sets up tracking so future `git push` and `git pull` commands work without specifying the remote.
+
+**2. Do your work and create logical commits:**
+```bash
+# Make changes...
+git add <files>
+git commit -s -m "feat: Add your feature description"
+```
+
+Use the `-s` flag to add the required DCO sign-off. See [Commit Message Guidelines](#commit-message-guidelines) for formatting details.
+
+**3. Push to your fork:**
+```bash
+git push
+```
+
+### Submitting a Pull Request
+
+**1. Before submitting, rebase on upstream/main:**
+```bash
+git fetch upstream
+git rebase upstream/main
+```
+
+Resolve any conflicts if they occur, then force push (needed because rebasing rewrites history):
+```bash
+git push -f
+```
+
+**2. Run tests locally:**
+```bash
+make test
+make lint
+```
+
+**3. Create the PR from GitHub:**
+
+When you're ready to submit your changes in a PR, visit either your fork or the main repo on GitHub. 
+If you've pushed recently, you'll see a prompt: "Compare & pull request" — click it.
+
+Alternatively, go to the upstream repository and click "New pull request", then select your fork and branch.
+
+## Guidelines
+
+### Discuss Before You Code
 
 **For significant changes**, discuss your approach upfront:
 - Open an issue describing the problem and proposed solution
 - For substantial features or architectural changes, create a design document in `docs/`
 - Wait for feedback from maintainers before investing significant effort
 - Small bug fixes and typos don't require prior discussion
 
-### 2. Work in Your Fork
-
-- Develop all changes in your own fork
-- Create feature branches from `main`:
-  ```bash
-  git checkout -b feature/your-feature-name
-  ```
-- Keep your fork's `main` branch in sync with upstream:
-  ```bash
-  git fetch upstream
-  git checkout main
-  git merge upstream/main
-  ```
-
-### 3. Keep PRs Small and Targeted
+### Keep PRs Small and Targeted
 
 - **Aim for PRs under 500 lines** whenever possible (not counting auto-generated code)
 - Each PR should address a single concern or feature
@@ -76,7 +140,7 @@ PR 3: Add UI components
 PR 4: Wire up UI to backend and add integration tests
 ```
 
-### 4. Coordinate Breaking Changes
+### Coordinate Breaking Changes
 
 If a breaking change is unavoidable:
 - Discuss in an issue first with the "breaking-change" label
@@ -85,23 +149,6 @@ If a breaking change is unavoidable:
 - For very large refactors, consider working from a branch in the main repository
 - Provide upgrade instructions in the PR description
 
-## Pull Request Guidelines
-
-### Before Submitting
-
-1. **Rebase on upstream/main** to ensure clean integration:
-   ```bash
-   git fetch upstream
-   git rebase upstream/main
-   ```
-2. **Run tests locally**:
-   ```bash
-   make test
-   make lint
-   ```
-3. **Update documentation** if your changes affect user-facing behavior
-4. **Add tests** for new functionality or bug fixes
-
 ### PR Requirements
 
 - **Title**: Clear, concise description of the change
@@ -243,7 +290,7 @@ make format
 
 ### Writing Tests
 
-- Test files should mirror source structure: `backend/src/foo/bar.py` → `tests/test_foo_bar.py`
+- Test files should mirror source structure: `src/neuralnav/foo/bar.py` → `tests/test_foo_bar.py`
 - Use descriptive test names: `test_plan_capacity_with_minimum_accuracy_threshold()`
 - Include both positive and negative test cases
 - Mock external dependencies (databases, APIs, LLM calls)
@@ -287,7 +334,7 @@ make format
 
 ## License
 
-By contributing to Compass, you agree that your contributions will be licensed under the same license as the project (see [LICENSE](LICENSE)).
+By contributing to NeuralNav, you agree that your contributions will be licensed under the same license as the project (see [LICENSE](LICENSE)).
 
 ## Questions?
 
@@ -296,4 +343,4 @@ If you have questions not covered here, please:
 2. Open a new issue with the "question" label
 3. Reach out to maintainers
 
-Thank you for contributing to Compass!
+Thank you for contributing to NeuralNav!

Dockerfile

@@ -0,0 +1,52 @@
+# Backend Dockerfile for NeuralNav
+FROM --platform=linux/amd64 python:3.11-slim
+
+# Set working directory
+WORKDIR /app
+
+# Install system dependencies
+RUN apt-get update && apt-get install -y \
+    curl \
+    gcc \
+    postgresql-client \
+    && rm -rf /var/lib/apt/lists/*
+
+# Install uv
+COPY --from=ghcr.io/astral-sh/uv:latest /uv /uvx /bin/
+
+# Copy dependency files and README (hatchling requires README.md for package metadata)
+COPY pyproject.toml uv.lock README.md ./
+
+# Install Python dependencies (frozen = use lockfile exactly, no-dev = skip dev deps)
+RUN uv sync --frozen --no-dev
+
+# Copy backend source code
+COPY src/neuralnav ./src/neuralnav
+
+# Copy data files (Knowledge Base)
+COPY data ./data
+
+# Copy scripts (schema init, benchmark loading — used by db-init Job)
+COPY scripts ./scripts
+
+# Create directories for generated files
+RUN mkdir -p /app/generated_configs /app/logs/prompts && \
+    chmod -R 770 /app/generated_configs /app/logs
+
+# Set environment variables
+ENV PYTHONPATH=/app/src
+ENV PYTHONUNBUFFERED=1
+# Use the venv created by uv sync (avoids uv run writing to .venv at runtime)
+ENV PATH="/app/.venv/bin:$PATH"
+
+ARG MODEL_CATALOG_URL
+
+# Expose backend API port
+EXPOSE 8000
+
+# Health check
+HEALTHCHECK --interval=30s --timeout=10s --start-period=40s --retries=3 \
+  CMD python -c "import requests; requests.get('http://localhost:8000/health').raise_for_status()" || exit 1
+
+# Run the backend API server
+CMD ["uvicorn", "neuralnav.api.app:app", "--host", "0.0.0.0", "--port", "8000", "--workers", "2"]

LICENSE

@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright 2025 The authors of Compass
+   Copyright 2025 The authors of NeuralNav
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.