Set-up and changelog sections, draft of quick start

Author: szjanikowski

docs/changelog.md

@@ -1,98 +1,56 @@
+---
+sidebar_position: 5
+---
+
 # Changelog
 
 All notable changes to the Noesis Vision application will be documented in this file.
 
-## [vision/0.3.0-preview10] - 2025-09-03
-
-### Improved
-- Enhanced stability of entry point description generation
-- Improved overall system reliability
-
-## [vision/0.3.0-preview09] - 2025-09-03
-
-### Improved
-- Fixed stability issues with entry point description creation
-- Enhanced glossary integration reliability
-
-## [vision/0.3.0-preview08] - 2025-09-02
-
-### Improved
-- Fixed stability issues with domain glossary retrieval
-- Enhanced error handling for missing glossary files
-
-## [vision/0.3.0-preview07] - 2025-09-02
-
-### Added
-- **Domain Glossary System**: Complete domain glossary generation and management
-- **New AI Models**: Support for Hugging Face models, QwenCoder7B, and Haiku
-- **Amazon Claude Integration**: Added support for Amazon Claude models with structured output
-- **Token Usage Monitoring**: Track AI model usage and costs
-- **Enhanced UI**: Improved glossary display and user interface
-
-### Changed
-- **Default AI Model**: Haiku is now the default AI model
-- **Storage Management**: Centralized storage across the application
-
-### Improved
-- Enhanced stability of element description generation
-- Improved glossary display and interaction
-
-## [vision/0.3.0-preview06] - 2025-08-14
-
-### Added
-- **Amazon Bedrock Integration**: Support for Amazon Bedrock AI models
-- **AI-Powered Descriptions**: AI-generated entry point descriptions
-- **Token Monitoring**: Comprehensive token usage tracking
-
-### Changed
-- **Model Selection**: Enhanced AI model selection capabilities
-- **Streaming Performance**: Better real-time data streaming of elements descriptions
-
-## [vision/0.3.0-preview05] - 2025-08-08
-
-### Improved
-- Enhanced error handling and logging consistency
-- Updated documentation and setup instructions
+## [vision/0.4.0] - Preview
 
-## [vision/0.3.0-preview04] - 2025-08-08
+### Product Features
 
-### Added
-- **Microsoft Semantic Kernel**: Full integration for enhanced AI capabilities
-- **GitHub Integration**: Context-aware analysis using GitHub repository information
-- **New Analysis Interface**: Enhanced analysis view for P3 models
-- **Improved Navigation**: Logo click navigation to home page
+**Code Analysis**
+- Automated source code analysis of .NET 5+ (.NET Core) repositories and extraction of a map of key architecture components structured according to the P3 model
+- Ability to configure analysis using Noesis DSL in .NET using public `Noesis.Parser` packages, which allows to define architecture conventions
+- Integration with Git repositories present on the file system of the host machine
 
-### Changed
-- **Default AI Model**: Switched to Haiku as the default AI model
-- **Enhanced Context**: Improved context retrieval for better analysis
+**Noesis User Interface** 
+- Visualization of the key architecture elements and their relationships in the form of trees, lists and diagrams
+- Supported browsing modes:
+    - By overall modules structure
+    - By application entry point and its dependencies to other elements
+- Each browsing mode includes:
+    - tree of detected elements organized according to the configuration of modules
+    - ability to visualize multiple selected elements in a form of diagram, with ability to filter and reorganize the elements on the diagram.
 
-## [vision/0.3.0-preview03] - 2025-08-06
+**LLM-powered map elements descriptions**
+- Effective bulk generation of so called Domain Glossary - LLM summaries of all mapped elements
+- Extended descriptions of entry points integrated with Domain Glossary
+- Streaming of elements description in the NoesisUI during LLM generation to see the results faster
+- Estimation of Domain Glossary generation cost and displaying it in the UI.
 
-### Improved
-- Fixed Docker container publishing workflow
-- Enhanced container deployment reliability
+**Variety of LLM Integration**
+- Support for multiple AI models: Amazon Bedrock, Hugging Face, Fireworks
+- Token usage and cost monitoring
 
-## [vision/0.3.0-preview02] - 2025-08-06
 
-### Added
-- **External Sources Support**: Support for external sources across projects
-- **Git Repository Integration**: Default branch support for Git configurations
-- **Enhanced Package Management**: Improved package restoration
+**Deployment & Infrastructure**
+- Noesis Vision application is deployed as a Docker Container 
+- Ability to configure the container using mounted configuration and environment variables
+- Ability to mount persistent storage unit for caches and results
 
-### Changed
-- **Project Structure**: Major project restructuring for better organization
-- **Container Publishing**: Enhanced Docker container publishing
 
-### Improved
-- Fixed FullAnalysis functionality stability
-- Enhanced configuration handling
-- Improved error handling for file operations
+### In Development
 
-## [vision/0.3.0-preview01] - 2025-07-31
+**Documentation Export**
+- Extended capabilities for exporting generated documentation
+- Multiple export formats (Markdown and others)
 
-### Added
-- **.NET 9 Support**: Added .NET 9 SDK support
-- **Enhanced CI/CD**: Improved deployment pipeline
+**UX Improvements**
+- User interface enhancements
+- Better user experience across the application
+- Performance and responsiveness optimization
 
 ---
 

docs/configure.md

@@ -1,5 +1,5 @@
 ---
-sidebar_position: 2
+sidebar_position: 3
 ---
 
 # Conventions configuration

docs/explore.md

@@ -1,5 +1,5 @@
 ---
-sidebar_position: 3
+sidebar_position: 4
 ---
 
 # Exploring with Noesis UI

docs/intro.md

@@ -8,7 +8,7 @@ sidebar_position: 0
 
 ## What is Noesis?
 
-Noesis automates the process of understanding system architecture through deterministic static analysis combined with AI-enhanced descriptions. It creates precise system maps without AI first, providing a solid foundation that allows you to use AI intelligently and efficiently only where it adds real value - giving you full control over costs and quality.
+Noesis automates the process of understanding system architecture through deterministic static analysis combined with AI-enhanced descriptions. It creates precise system maps without AI first, providing a solid foundation that allows you to use AI intelligently and efficiently only where it adds real value—giving you full control over costs and quality.
 
 :::info Current Support
 Noesis currently supports analysis of **.NET repositories**. Support for additional programming languages and frameworks is planned for future releases.
@@ -24,32 +24,32 @@ Point Noesis to your .NET codebase you want to explore.
 ### 2. [Define conventions with DSL](/docs/configure) 🔧
 Specify your architectural rules and conventions in a lightweight domain-specific language.
 
-### 3. [Run deterministic static analysis](/docs/configure) 🔍
+### 3. [Map software using deterministic static analysis](/docs/configure) 🔍
 Noesis scans the code using static analysis and generates a repeatable map of the system's essential building blocks.
 
 ### 4. [Use the map in multiple ways](/docs/explore) 🚀
-Navigate, document, and integrate with AI for comprehensive system understanding.
+Navigate, document, and integrate with AI for comprehensive system understanding. 
 
 ## Multiple Ways to Use Your System Map
 
 ### Noesis UI
-Navigate interactively through AI-described modules, entry points, and key components to visually explore their connections and analyze your system.
+Navigate interactively through LLM-described map elements—modules, entry points, and other key components—to visually explore their connections and analyze your system.
 
 ### Documentation
-Export Noesis map content to clear, static documentation - share it with clients or integrate with your internal wiki for comprehensive system overview wherever you need it.
+Export Noesis map content to clear, static documentation—share it with clients or integrate with your internal wiki for comprehensive system overview wherever you need it.
 
 ### AI Integration (MCP)
-*Coming soon* - Expose the map or documentation to AI agents via Model Context Protocol (MCP) for more meaningful, context-aware conversations.
+*Coming soon*—Expose the map or documentation to AI agents via Model Context Protocol (MCP) for more meaningful, context-aware conversations.
 
 ## Key Features
 
-- **🔒 Secure**: On-premise deployment - your code never leaves your infrastructure
+- **🔒 Secure**: On-premise deployment—your code never leaves your infrastructure
 - **🎯 Deterministic**: Precise system map creation using static code analysis
 - **🤖 AI-Enhanced**: Selective AI usage only where it adds value
 - **📊 Visual**: Interactive diagrams and architecture visualizations
 - **📚 Comprehensive**: Generates detailed documentation automatically
 - **🔧 Configurable**: Flexible DSL for custom architectural patterns
-- **🔄 Repeatable**: Comparable & repeatable analysis across multiple scans
+- **🔄 Repeatable**: Comparable and repeatable analysis across multiple scans
 - **💰 Cost-Optimized**: Full control over AI costs and quality
 
 ## Real-World Applications
@@ -65,6 +65,7 @@ Noesis transforms how teams approach complex software challenges:
 
 ## Quick Links
 
+- [Quick Start Guide](/docs/quick-start)
 - [Installation Guide](/docs/setup)
 - [Configuration Examples](/docs/configure)
 - [UI Overview](/docs/explore)
@@ -77,4 +78,4 @@ Noesis transforms how teams approach complex software challenges:
 - Read the [latest updates](/docs/changelog)
 - Join our [Discord community](https://discord.gg/noesis)
 
-Ready to get started? Begin with [Set-up](/docs/setup) to deploy Noesis on your infrastructure.
+Ready to get started? Begin with [Quick Start](/docs/quick-start) to get up and running in minutes.

docs/quick-start.md

@@ -0,0 +1,131 @@
+---
+sidebar_position: 1
+---
+
+# Quick Start
+
+Get up and running with Noesis in just a few simple steps! This guide will walk you through basic configuration and running your first scan of your .NET repository.
+
+## Prerequisites
+
+Before you begin, make sure you have:
+
+- **Docker** installed on your system
+- **Docker access token** obtained from Noesis team
+- **Noesis license file** (`.jwt`) obtained from Noesis team
+- **A .NET 5+ repository** to analyze
+- **Basic knowledge** of Docker and .NET project structure
+
+
+
+## Step 1: Prepare Directory Structure
+
+We recommend to create the following directory structure on your system:
+
+```
+noesis-workspace/
+├── data/           # Noesis data (cache, results)
+└── license.jwt     # License file
+```
+
+```bash
+mkdir -p noesis-workspace/{data}
+# Copy your license file to noesis-workspace/license.jwt
+```
+
+## Step 2: Run Noesis with zero config 
+
+As a first step you should just start Noesis container without any individual config to check if you are able to access the UI and browse through the example repositories shipped together with Noesis distribution. 
+
+You need to: 
+1. Login to docker using Docker access token obtained from noesis team 
+1. Mount the license.jwt 
+
+Here is the sample command: 
+
+TBD
+
+
+## Step 3: Configure Basic Architecture Convention
+
+In the `config/` directory, create a .NET project with basic DSL configuration:
+
+```bash
+cd noesis-workspace/config
+dotnet new classlib -n NoesisConfig
+cd NoesisConfig
+```
+
+Create the `ArchitectureConventions.cs` file:
+
+```csharp
+using Noesis.Parser;
+
+namespace NoesisConfig
+{
+    //TODO
+}
+```
+
+## Step 4: Run Noeis with your sources and configuration
+
+Run the Docker container with basic configuration:
+
+```bash
+cd noesis-workspace
+
+docker run \
+  -v $(pwd)/config:/externalConfig:ro \
+  -v $(pwd)/sources:/externalSources:ro \
+  -v $(pwd)/data:/data \
+  -v $(pwd)/license.jwt:/license.jwt:ro \
+  -p 3000:8080 \
+  --rm \
+  ghcr.io/noesisvision/vision:latest
+```
+
+## Step 5: Open the User Interface
+
+After starting the container, open your browser and navigate to:
+
+```
+http://localhost:3000
+```
+
+## Step 6: Run Your First Scan
+
+1. In the Noesis interface, click **"Start Scan"**
+2. Select your repository from the list of available projects
+3. Wait for the analysis to complete (may take a few minutes)
+
+## Step 7: Explore Results
+
+After the scan completes, you can:
+
+- **Browse modules** - see how Noesis identified your project structure
+- **Analyze diagrams** - visualize relationships between components
+- **Export documentation** - generate Markdown files with results
+
+## Next Steps
+
+Congratulations! You've successfully run your first scan in Noesis. Now you can:
+
+- **[Configure advanced conventions](/docs/configure)** - customize architectural rules to your needs
+- **[Explore the interface](/docs/explore)** - learn to use all Noesis UI features
+- **[Add AI integration](/docs/setup#optional-llm-integration)** - enable component description generation
+
+## Troubleshooting
+
+### Issue: Container won't start
+- Check if all volumes are properly mounted
+- Ensure the license file is accessible
+- Check container logs: `docker logs <container_id>`
+
+## Need Help?
+
+TBD Discord link
+
+- Check the [full installation guide](/docs/setup)
+- Review [configuration examples](/docs/configure)
+- Visit our [GitHub repository](https://github.com/noesisvision/noesis)
+- Join our [Discord community](https://discord.gg/noesis)