Skip to content

Commit ffc0ff9

Browse files
committed
(maint) Update user interaction diagram
Previously, a conceptual diagram for Facter was stored as an image file and embedded in the README. This commit updates that diagram to a Mermaid-based Markdown format written directly in the README and deletes the docs directory and its only contents, the image file of the diagram.
1 parent 3c43f9e commit ffc0ff9

File tree

2 files changed

+13
-1
lines changed

2 files changed

+13
-1
lines changed

README.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,19 @@ Facts are the nuggets of information that will be provided by facter e.g. `os.na
4040
Resolvers have the role of gathering data from the system.
4141
For example a resolver can execute a command on the system, can read a file or any operation that retrieves some data from a single source on the system.
4242

43-
![Facter user interaction](docs/diagrams/facter_user_interaction.png?raw=true)
43+
```mermaid
44+
sequenceDiagram
45+
participant user
46+
participant framework
47+
participant fact
48+
participant resolver
49+
user->>framework: user query
50+
framework->>fact: create
51+
fact->>resolver: resolve
52+
resolver->>fact: system information
53+
fact->>framework: fact value
54+
framework->>user: formatted user output
55+
````
4456
4557
## Getting started
4658
After cloning the project, run `bundle install` to install all dependencies.
-22.5 KB
Binary file not shown.

0 commit comments

Comments
 (0)