Skip to content

docs(configuration): rewrite configuration.md to reflect actual Python framework architecture#1366

Merged
bryanadenhq merged 1 commit intoaden-hive:mainfrom
tjsasakifln:fix/1332-rewrite-configuration-docs
Jan 29, 2026
Merged

docs(configuration): rewrite configuration.md to reflect actual Python framework architecture#1366
bryanadenhq merged 1 commit intoaden-hive:mainfrom
tjsasakifln:fix/1332-rewrite-configuration-docs

Conversation

@tjsasakifln
Copy link
Contributor

Summary

  • Rewrites docs/configuration.md to document the actual Python-based framework instead of a non-existent Node.js/Docker/React/PostgreSQL stack
  • Covers environment variables, agent config.py, agent.json schema, MCP server configuration, file-based storage, IDE setup, security best practices, and troubleshooting
  • All content verified against actual codebase (.env.example, ENVIRONMENT_SETUP.md, os.environ usage in core/)

Fixes #1332

What changed

The previous configuration.md described infrastructure that does not exist in this project (Docker Compose, PostgreSQL, Redis, React frontend, JWT/CORS, honeycomb/ directory). This rewrite replaces every section with accurate documentation:

Section Before (wrong) After (correct)
Overview Docker + Node.js + PostgreSQL Environment vars + Agent config + pyproject.toml + .mcp.json
Environment DATABASE_URL, JWT_SECRET, CORS_ORIGIN ANTHROPIC_API_KEY, OPENAI_API_KEY, BRAVE_SEARCH_API_KEY, MOCK_MODE
Database PostgreSQL schema, migrations, connection pooling File-based persistence via framework.storage.FileStorage
Frontend React, Vite, theme config N/A (CLI-only project)
Agent config N/A config.py per agent, agent.json graph spec
MCP N/A .mcp.json server configuration
IDE N/A VS Code and PyCharm source root setup
Troubleshooting N/A ModuleNotFoundError, API key, agent resolution

No links to configuration.md from other files (README translations, DEVELOPER.md) were broken since the file path is preserved.

Test plan

  • Verify every environment variable listed exists in .env.example or codebase os.environ calls
  • Verify every file path referenced (exports/, config.py, agent.json, .mcp.json) exists in the repo
  • Verify no references to removed concepts (Docker, PostgreSQL, React, honeycomb) remain
  • Verify all cross-references from README translations and DEVELOPER.md still resolve

Copy link
Collaborator

@bryanadenhq bryanadenhq left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it looks great, thanks for your contribution!

@bryanadenhq
Copy link
Collaborator

Hi @tjsasakifln, there seems to be a merge conflict, could you please rebase with main before I merge? Thanks!

@tjsasakifln tjsasakifln force-pushed the fix/1332-rewrite-configuration-docs branch from 8adf56b to ca031f3 Compare January 28, 2026 18:18
@tjsasakifln
Copy link
Contributor Author

@bryanadenhq Thanks for the review and the heads-up on the merge conflict! Rebased on main — should be clean to merge now.

@bryanadenhq bryanadenhq merged commit 50087bb into aden-hive:main Jan 29, 2026
4 checks passed
Aden Hive is a Python-based agent framework. Configuration is handled through environment variables and agent-level config files. There is no centralized `config.yaml` or Docker Compose setup.

## Configuration Flow
## Configuration Overview
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Information-API & Infra-Energy Optimisation

Overview

This project integrates information theory, thermodynamics, statistics, quantum principles, and distributed systems security into one framework.

Components

  • Shannon Entropy → Optimises information flow in APIs.
  • Thermodynamic Entropy → Models infra-energy efficiency.
  • P-value Analysis → Validates statistical significance of human judgement in LLM outputs.
  • MCMC Simulation → Models uncertainty in decision-making.
  • Kafka + Turing Machine Security → Ensures secure message passing with Schrödinger’s cat principle (secure/insecure until consumed).
  • Terraform Automation → Deploys infrastructure automatically.

Usage

  1. Run python main.py to execute entropy, statistical, and MCMC simulations.
  2. Ensure Kafka is running locally for the security demo.
  3. Deploy infra with:
    terraform init
    terraform apply

jhalak999 pushed a commit to jhalak999/hive that referenced this pull request Feb 17, 2026
…onfiguration-docs

docs(configuration): rewrite configuration.md to reflect actual Python framework architecture
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Bug]: configuration.md documents a Node.js/Docker/React stack that does not exist in the repository

3 participants