From eb41c0960afb2b268a58bdb00fb3d6391bba7390 Mon Sep 17 00:00:00 2001 From: markjuliusbanasihan <90214617+mj3b@users.noreply.github.com> Date: Thu, 19 Jun 2025 19:33:35 -0400 Subject: [PATCH] docs: enhance README usability --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index 452048384..59588c770 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,7 @@ **JUNO: AI-driven analytics for Jira.** This repository hosts the agentic platform that augments Jira with natural language queries and data-driven insights. Built on Enterprise GPT, JUNO translates Jira activity into actionable reports covering defects, velocity trends, and project health. Ask questions in plain English to obtain rigorous answers backed by your issue tracker. **Optimized for Atlassian Cloud**: JUNO is designed for secure, high-performance deployments. It leverages Atlassian's APIs and cloud-native practices to integrate seamlessly with enterprise environments. +
Important Notes: JUNO leverages advanced generative AI. Review the technical specifications and enterprise implementation guide before deploying in production.
--- @@ -221,6 +222,7 @@ juno-repo/ --- ## Quick Start +
Expand Quick Start instructions A minimal setup to launch JUNO locally. For the full environment setup and detailed instructions, see the @@ -240,8 +242,10 @@ cd juno # Open the dashboard open http://localhost:5000 ``` +
## Code Structure +
Expand Code Map ### Directory Overview @@ -304,8 +308,10 @@ juno/ - [`reinforcement_learning.py`](./juno-agent/src/phase4/reinforcement_learning.py) - Reinforcement learning optimization - [`threat_detection.py`](./juno-agent/src/phase4/threat_detection.py) - Threat detection and response - [`self_healing.py`](./juno-agent/src/phase4/self_healing.py) - Self-healing infrastructure management +
## Enterprise Deployment +
Expand deployment details ### Production Architecture @@ -367,6 +373,7 @@ security: at_rest: "AES-256-GCM" in_transit: "TLS-1.3" ``` +
## API Reference