Merge pull request #32 from ts-graphviz/improve-architecture-and-design-principles

Improve architecture and design principles

Author: kamiazya

docs/ts-graphviz/02-core-features/index.md renamed to docs/ts-graphviz/01-getting-started/04-core-features.md

@@ -26,7 +26,7 @@ Ensure that [Graphviz](https://graphviz.org/download/) is installed on your syst
 ### Converting DOT to an Image Stream
 
 ```typescript
-import { toStream } from '@ts-graphviz/adapter';
+import { toStream } from 'ts-graphviz/adapter';
 
 const dot = `
   digraph example {
@@ -46,7 +46,7 @@ await stream.pipeTo(Deno.stdout.writable);
 ### Writing DOT to an Image File
 
 ```typescript
-import { toFile } from '@ts-graphviz/adapter';
+import { toFile } from 'ts-graphviz/adapter';
 
 const dot = `
   digraph example {
@@ -63,7 +63,7 @@ await toFile(dot, './result.svg', { format: 'svg' });
 - **Output Formats**: Specify the desired output format (e.g., `svg`, `png`) through the options.
 - **Runtime Compatibility**: Designed to work seamlessly in both Node.js and Deno environments.
 
-## When to Use `@ts-graphviz/adapter`
+## When to Use `ts-graphviz/adapter` module
 
 - When you need to render your graphs into image files for visualization.
 - If you want to generate images dynamically within your application.

docs/ts-graphviz/01-getting-started/04-glossary.md renamed to docs/ts-graphviz/01-getting-started/09-glossary.md

@@ -1,9 +1,9 @@
 ---
-description: How to extend ts-graphviz with custom classes.
+description: How to extend ts-graphviz for advanced use cases.
 ---
 # Extending ts-graphviz
 
-`ts-graphviz` is designed to be extensible, allowing advanced users to customize and enhance the library's functionality to meet specific needs. This section covers how to extend the type system and create custom implementations.
+`ts-graphviz` is designed to be extensible, allowing intermediate users to customize and enhance the library's functionality to meet specific needs. This section covers how to extend the type system and create custom implementations.
 
 ## Creating Custom Classes
 
@@ -172,3 +172,58 @@ console.log(
   ),
 );
 ```
+
+---
+
+
+## Internal Package Overview
+
+For users interested in extending or customizing `ts-graphviz`, understanding the internal packages can be valuable. Below is an overview of the internal packages and how they can be used in advanced scenarios.
+
+
+### `@ts-graphviz/adapter`
+
+**Purpose**: Provides interfaces to execute Graphviz commands and convert DOT language strings into various output formats.
+
+**Usage**:
+
+- Convert DOT strings to streams or files.
+- Use in environments where you need to render graphs to images or other formats.
+
+:::note
+You can use either `@ts-graphviz/adapter` or `ts-graphviz/adapter` imports. The latter is maintained for backward compatibility.
+:::
+
+
+### `@ts-graphviz/ast`
+
+**Purpose**: Allows manipulation of the DOT language at the Abstract Syntax Tree (AST) level.
+
+**Usage**:
+
+- Parse DOT strings into AST nodes.
+- Manipulate and transform the AST programmatically.
+- Useful for advanced analysis or transformations of existing DOT code.
+
+:::note
+You can use either `@ts-graphviz/ast` or `ts-graphviz/ast` imports. The latter is maintained for backward compatibility.
+:::
+
+### `@ts-graphviz/common`
+
+**Purpose**: Centralizes Graphviz domain knowledge, providing type definitions, constants, and utilities. It is designed to handle use cases such as extending types.
+
+**Usage**:
+
+- Extend or customize types and attributes.
+- Ensure type safety when working with custom attributes.
+- Aggregate domain knowledge of Graphviz for consistent usage across packages.
+
+### `@ts-graphviz/core`
+
+**Purpose**: Contains the core implementations of the models and functions provided to users.
+
+**Usage**:
+
+- Use object-oriented APIs for fine-grained control over graph elements.
+- Extend classes for custom behaviors or attributes.