on_boarding.md

graph LR
    Command_Layer["Command Layer"]
    Guidance_Service_Layer["Guidance Service Layer"]
    Storage_Layer["Storage Layer"]
    Version_Control_Integration_Component["Version Control Integration Component"]
    LLM_Integration_Component["LLM Integration Component"]
    Configuration_Management_Component["Configuration Management Component"]
    Command_Layer -- "initiates requests to" --> Guidance_Service_Layer
    Guidance_Service_Layer -- "returns results to" --> Command_Layer
    Guidance_Service_Layer -- "requests persistence from" --> Storage_Layer
    Guidance_Service_Layer -- "retrieves entities from" --> Storage_Layer
    Storage_Layer -- "utilizes" --> Version_Control_Integration_Component
    Version_Control_Integration_Component -- "provides versioning capabilities for" --> Storage_Layer
    Command_Layer -- "interacts with" --> Configuration_Management_Component
    Guidance_Service_Layer -- "reads settings from" --> Configuration_Management_Component
    Command_Layer -- "initiates requests to" --> LLM_Integration_Component
    Guidance_Service_Layer -- "calls for content processing from" --> LLM_Integration_Component
    click Command_Layer href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/gydnc/Command_Layer.md" "Details"
    click Storage_Layer href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/gydnc/Storage_Layer.md" "Details"
    click Version_Control_Integration_Component href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/gydnc/Version_Control_Integration_Component.md" "Details"

Loading

Details

The gydnc project is structured around a command-line interface (CLI) for managing "guidance entities." The core flow involves the Command Layer receiving user input, which then interacts with the Guidance Service Layer to perform business logic operations. These operations often require persistent storage, handled by the Storage Layer, which in turn leverages the Version Control Integration Component for tracking changes. Additionally, the system integrates with LLM Integration Component for content processing and relies on the Configuration Management Component for application settings.

Command Layer [Expand]

Handles CLI input, argument parsing, and dispatches requests to the appropriate service layer functions. It serves as the primary user interface for the gydnc tool.

Related Classes/Methods:

• cmd/root.go
• cmd/create.go
• cmd/get.go
• cmd/list.go
• cmd/update.go
• cmd/delete.go
• cmd/backends.go
• cmd/llm.go
• cmd/config.go

Guidance Service Layer

Encapsulates core business logic for managing guidance entities. It orchestrates operations such as creation, retrieval, updating, and deletion, applying business rules and interacting with the Storage Layer.

Related Classes/Methods:

• core/content/guidance.go

Storage Layer [Expand]

Manages persistent storage and retrieval of guidance entities, abstracting the underlying file-based mechanism. It interacts with the file system to read, write, and manage .g6e files.

Related Classes/Methods:

• .gydnc/

Version Control Integration Component [Expand]

Provides versioning capabilities for guidance entities, leveraging Git for tracking changes and history. This component is implicitly used by the Storage Layer when the storage backend is a Git-managed directory.

Related Classes/Methods:

• .git/

LLM Integration Component

Facilitates interaction with Language Model Models for content generation, refinement, or analysis, as exposed through specific CLI commands.

Related Classes/Methods:

• cmd/llm.go

Configuration Management Component

Manages application-wide settings and configurations, including backend definitions and default behaviors.

Related Classes/Methods:

• cmd/config.go

FAQ