# dargoz/grimoire architecture

> Architecture diagram of the GitHub repository dargoz/grimoire, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-01). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/dargoz/grimoire
- Repository: https://github.com/dargoz/grimoire

## Overview

Grimoire is a cross-platform wiki for documentation stored in Git repositories. Its documented user workflow is to configure a project path and Git access token, then browse versioned documents and search their content; flavored Markdown is a presentation capability. The tree shows distinct auth, wiki data/domain, and presentation areas, but no Dart source excerpts were provided, so internal calls and data transfers cannot be verified. The graph therefore uses README-supported product relationships and omits unverified internal wiring. Platform runner and generated-plugin files are host scaffolding, not product components.

Main entry points: [`lib/features/wiki/presentation/pages/document_page.dart`](https://github.com/dargoz/grimoire/blob/main/lib/features/wiki/presentation/pages/document_page.dart) (Document viewing), [`lib/features/wiki/domain/usecases/get_version_use_case.dart`](https://github.com/dargoz/grimoire/blob/main/lib/features/wiki/domain/usecases/get_version_use_case.dart) (Commit versions), [`lib/features/wiki/data/sources/remote/gitlab`](https://github.com/dargoz/grimoire/tree/main/lib/features/wiki/data/sources/remote/gitlab) (Git repository source), [`lib/main.dart`](https://github.com/dargoz/grimoire/blob/main/lib/main.dart) (Grimoire app)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_access["App access"]
  node_app["Grimoire app<br/>[main.dart]"]
  node_routes["App routing"]
  node_login["Login experience<br/>[login_page.dart]"]
  node_auth["Token access"]
end

subgraph group_wiki["Wiki experience"]
  node_wiki_home["Wiki explorer"]
  node_file_tree["Repository browser"]
  node_document["Document viewing<br/>[document_page.dart]"]
  node_markdown["Markdown rendering"]
  node_versioning["Commit versions"]
  node_search_ui["Content search"]
end

subgraph group_content["Content services"]
  node_wiki_domain["Wiki operations"]
  node_wiki_repository["Wiki repository"]
  node_git_source["Git repository source"]
  node_local_cache[("Local wiki data")]
  node_search_domain["Search operations"]
  node_search_repository["Search repository"]
  node_search_engine["Typesense service"]
end

subgraph group_platform["Local support"]
  node_credential_store[("Credential storage")]
end

node_user(("Reader / editor"))
node_git_service["Git host"]

node_user -->|"uses"| node_app
node_user -->|"configures access"| node_login
node_user -->|"browses content"| node_wiki_home
node_user -->|"searches content"| node_search_ui
node_user -->|"reads documents"| node_document
node_git_source -->|"reads repository"| node_git_service
node_versioning -->|"uses commit history"| node_git_service
node_document -->|"renders flavored Markdown"| node_markdown

click node_app "https://github.com/dargoz/grimoire/blob/main/lib/main.dart"
click node_routes "https://github.com/dargoz/grimoire/tree/main/lib/routes"
click node_login "https://github.com/dargoz/grimoire/blob/main/lib/features/auth/presentation/pages/login_page.dart"
click node_auth "https://github.com/dargoz/grimoire/tree/main/lib/features/auth/domain/usecases"
click node_credential_store "https://github.com/dargoz/grimoire/tree/main/lib/features/auth/data/sources/local"
click node_wiki_home "https://github.com/dargoz/grimoire/blob/main/lib/features/wiki/presentation/pages/grimoire_home_page.dart"
click node_file_tree "https://github.com/dargoz/grimoire/blob/main/lib/features/wiki/presentation/controllers/file_tree_controller.dart"
click node_document "https://github.com/dargoz/grimoire/blob/main/lib/features/wiki/presentation/pages/document_page.dart"
click node_markdown "https://github.com/dargoz/grimoire/tree/main/lib/features/wiki/presentation/utils"
click node_versioning "https://github.com/dargoz/grimoire/blob/main/lib/features/wiki/domain/usecases/get_version_use_case.dart"
click node_search_ui "https://github.com/dargoz/grimoire/blob/main/lib/features/wiki/presentation/controllers/search_controller.dart"
click node_wiki_domain "https://github.com/dargoz/grimoire/tree/main/lib/features/wiki/domain/usecases"
click node_wiki_repository "https://github.com/dargoz/grimoire/blob/main/lib/features/wiki/data/repositories/wiki_repository_impl.dart"
click node_git_source "https://github.com/dargoz/grimoire/tree/main/lib/features/wiki/data/sources/remote/gitlab"
click node_local_cache "https://github.com/dargoz/grimoire/blob/main/lib/features/wiki/data/sources/local/local_data_source_impl.dart"
click node_search_domain "https://github.com/dargoz/grimoire/blob/main/lib/features/wiki/domain/usecases/search_document_use_case.dart"
click node_search_repository "https://github.com/dargoz/grimoire/blob/main/lib/features/wiki/data/repositories/search_repository_impl.dart"
click node_search_engine "https://github.com/dargoz/grimoire/tree/main/lib/features/wiki/data/sources/remote/typesense"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_app,node_routes,node_login,node_auth toneBlue
class node_wiki_home,node_file_tree,node_document,node_markdown,node_versioning,node_search_ui toneAmber
class node_wiki_domain,node_wiki_repository,node_git_source,node_local_cache,node_search_domain,node_search_repository,node_search_engine toneMint
class node_credential_store toneRose
class node_user,node_git_service toneIndigo
```

## Components

### App access

- [Grimoire app](https://github.com/dargoz/grimoire/blob/main/lib/main.dart): `lib/main.dart`
- [App routing](https://github.com/dargoz/grimoire/tree/main/lib/routes): `lib/routes`
- [Login experience](https://github.com/dargoz/grimoire/blob/main/lib/features/auth/presentation/pages/login_page.dart): `lib/features/auth/presentation/pages/login_page.dart`
- [Token access](https://github.com/dargoz/grimoire/tree/main/lib/features/auth/domain/usecases): `lib/features/auth/domain/usecases`

### Wiki experience

- [Wiki explorer](https://github.com/dargoz/grimoire/blob/main/lib/features/wiki/presentation/pages/grimoire_home_page.dart): `lib/features/wiki/presentation/pages/grimoire_home_page.dart`
- [Repository browser](https://github.com/dargoz/grimoire/blob/main/lib/features/wiki/presentation/controllers/file_tree_controller.dart): `lib/features/wiki/presentation/controllers/file_tree_controller.dart`
- [Document viewing](https://github.com/dargoz/grimoire/blob/main/lib/features/wiki/presentation/pages/document_page.dart): `lib/features/wiki/presentation/pages/document_page.dart`
- [Markdown rendering](https://github.com/dargoz/grimoire/tree/main/lib/features/wiki/presentation/utils): `lib/features/wiki/presentation/utils`
- [Commit versions](https://github.com/dargoz/grimoire/blob/main/lib/features/wiki/domain/usecases/get_version_use_case.dart): `lib/features/wiki/domain/usecases/get_version_use_case.dart`
- [Content search](https://github.com/dargoz/grimoire/blob/main/lib/features/wiki/presentation/controllers/search_controller.dart): `lib/features/wiki/presentation/controllers/search_controller.dart`

### Content services

- [Wiki operations](https://github.com/dargoz/grimoire/tree/main/lib/features/wiki/domain/usecases): `lib/features/wiki/domain/usecases`
- [Wiki repository](https://github.com/dargoz/grimoire/blob/main/lib/features/wiki/data/repositories/wiki_repository_impl.dart): `lib/features/wiki/data/repositories/wiki_repository_impl.dart`
- [Git repository source](https://github.com/dargoz/grimoire/tree/main/lib/features/wiki/data/sources/remote/gitlab): `lib/features/wiki/data/sources/remote/gitlab`
- [Local wiki data](https://github.com/dargoz/grimoire/blob/main/lib/features/wiki/data/sources/local/local_data_source_impl.dart): `lib/features/wiki/data/sources/local/local_data_source_impl.dart`
- [Search operations](https://github.com/dargoz/grimoire/blob/main/lib/features/wiki/domain/usecases/search_document_use_case.dart): `lib/features/wiki/domain/usecases/search_document_use_case.dart`
- [Search repository](https://github.com/dargoz/grimoire/blob/main/lib/features/wiki/data/repositories/search_repository_impl.dart): `lib/features/wiki/data/repositories/search_repository_impl.dart`
- [Typesense service](https://github.com/dargoz/grimoire/tree/main/lib/features/wiki/data/sources/remote/typesense): `lib/features/wiki/data/sources/remote/typesense`

### Local support

- [Credential storage](https://github.com/dargoz/grimoire/tree/main/lib/features/auth/data/sources/local): `lib/features/auth/data/sources/local`

### Other components

- **Reader / editor**
- **Git host**

## Connections

- Reader / editor → Grimoire app: uses (evidence: `README.md`)
- Reader / editor → Login experience: configures access (evidence: `README.md`)
- Reader / editor → Wiki explorer: browses content (evidence: `README.md`)
- Reader / editor → Content search: searches content (evidence: `README.md`)
- Reader / editor → Document viewing: reads documents (evidence: `README.md`)
- Git repository source → Git host: reads repository (evidence: `README.md`)
- Commit versions → Git host: uses commit history (evidence: `README.md`)
- Document viewing → Markdown rendering: renders flavored Markdown (evidence: `README.md`)
