Merge pull request #6 from lenadoc/navigation

Improving the navigation

Author: lenadoc

docs/create-project.md

@@ -0,0 +1,8 @@
+# How to build the website locally
+
+1. Clone the website
+2. Make your changes and create a pull request.
+3. To build the site locally, run `mkdocs serve`. The website is accessible locally at http://127.0.0.1:8000/
+
+todo: analytics: https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-analytics/?h=page#was-this-page-helpful
+Edit on github

docs/how-to-build.md

@@ -1,6 +1,28 @@
-# Welcome to the SoftwareGuide Documentation
+# Welcome to the SoftwareGuide documentation
 
-Welcome to **SoftwareGuide**! This guide will help you navigate through creating, installing, and using your software projects effectively. Whether you're a beginner or an expert, you'll find helpful tips, notes, and detailed instructions in this documentation.
+Welcome to the comprehensive documentation for our software platform. This guide will help you understand, install, and use our software effectively.
+
+!!! tip "Quick start"
+    New to the platform? Start with our [Installation Guide](installation.md) and then follow our [Create a Project](usage/create-project.md) tutorial.
+
+## Key Features
+This is a sample description of features.
+
+### Feature 1
+Description of feature 1.
+
+### Feature 2
+Description of feature 2.
+
+| Feature | Description | Status |
+|---------|------------|---------|
+| Project Management | Create and manage projects | ✅ Available |
+| Process Automation | Automate repetitive tasks | ✅ Available |
+| Testing Framework | Comprehensive testing tools | 🚧 Beta 
+
+For a detailed overview of all features, see the [SoftwareProject overview](overview.md).
+
+---
 
 
 

docs/index.md

@@ -1,18 +1,31 @@
-# Installation
-## Requirements
-- Windows 11
-- Python 3.8 or higher
-
-## Steps
-1. Download the installer.
-2. Run the installer and follow the instructions.
-3. Verify the installation by typing `software --version` in the command line.
-
-| Requirement      | Minimum Version |
-|------------------|-----------------|
-| Python           | 3.8            |
-| Operating System | Windows 11     |
-
-## Additional Resources
-- [Official Website](https://example.com)
-- [GitHub Repository](https://github.com/example)
+# Installation Guide
+
+## System Requirements
+
+- Python 3.8+
+- Docker 20.10+
+- 4GB RAM minimum
+
+## Installation Steps
+
+1. Clone the repository:
+```bash
+git clone https://github.com/your-org/your-repo.git
+```
+
+2. Install dependencies:
+```bash
+pip install -r requirements.txt
+```
+
+!!! warning "Docker Required"
+    Make sure Docker is running before proceeding with the installation.
+
+??? question "Common Installation Issues"
+    - Port 8080 already in use
+    - Docker daemon not running
+    - Insufficient permissions
+
+Ready to start? Head to [Create a Project](usage/create-project.md)!
+
+---

docs/installation.md

@@ -0,0 +1,26 @@
+# SoftwareProject overview
+
+## About the Platform
+
+Our software platform provides robust tools for project management and process automation. This overview will help you understand the core capabilities and architecture.
+
+### Architecture Diagram
+
+```mermaid
+graph TD
+    A[Client] --> B[API Gateway]
+    B --> C[Project Service]
+    B --> D[Process Service]
+    B --> E[Test Service]
+```
+
+### Key Components
+
+1. Project Service: Handles project creation and management
+2. Process Service: Manages automated workflows
+3. Test Service: Handles test execution and reporting
+
+!!! note "Integration"
+    All services communicate through a secure API Gateway. Learn more in the [Installation Guide](installation.md).
+
+---

docs/introduction.md

@@ -0,0 +1,30 @@
+# Create a Process
+
+## Process Types
+
+Our platform supports various process types:
+
+| Process Type | Use Case            | Complexity |
+|--------------|---------------------|------------|
+| Sequential   | Simple workflows    | Low        |
+| Parallel     | Multiple streams    | Medium     |
+| Conditional  | Decision-based      | High       |
+
+## Creating a Process
+
+1. Open your [project](create-project.md)
+2. Select "New Process"
+3. Choose a process type
+4. Configure steps
+
+!!! example "Example Process"
+    ```yaml
+    process:
+      name: Document Approval
+      steps:
+        - review
+        - approve
+        - publish
+    ```
+
+---

docs/overview.md

@@ -0,0 +1,20 @@
+# Create a Project
+
+## Project Creation Guide
+
+Follow these steps to create your first project:
+
+1. Navigate to the Projects dashboard
+2. Click "New Project"
+3. Fill in project details:
+    - Name
+    - Description
+    - Team members
+
+!!! tip "Project Templates"
+    Use our pre-built templates to get started quickly. Access them from the "Templates" dropdown.
+
+See [Create a Process](create-process.md) for next steps.
+
+
+![Sample Image](/images/this-is-fine.jpg)

docs/usage/create-process.md

@@ -0,0 +1,17 @@
+# How to Use the Software
+
+This section provides detailed guides for using our software platform:
+
+1. [Create a Project](create-project.md): Learn how to set up your first project
+2. [Create a Process](create-process.md): Automate your workflows
+3. [Test the Project](test-project.md): Ensure quality and reliability
+
+## Getting Started
+
+Review the following checklist before proceeding:
+
+- [x] Complete installation
+- [ ] Configure environment
+- [ ] Create first project
+
+---

docs/usage/create-project.md

@@ -0,0 +1,34 @@
+# Test the Project
+
+## Testing Framework
+
+Our testing framework supports:
+
+- Unit Testing
+- Integration Testing
+- End-to-End Testing
+
+### Running Tests
+
+```bash
+# Run all tests
+pytest
+
+# Run specific test suite
+pytest tests/unit/
+```
+
+!!! success "Best Practices"
+    1. Write tests first
+    2. Use meaningful names
+    3. Test edge cases
+
+??? example "Sample Test Code"
+    ```python
+    def test_project_creation():
+        project = Project("Test")
+        assert project.name == "Test"
+        assert project.status == "Active"
+    ```
+
+See [Installation Guide](../installation.md) for setup requirements.