File tree Expand file tree Collapse file tree 1 file changed +35
-0
lines changed
Expand file tree Collapse file tree 1 file changed +35
-0
lines changed Original file line number Diff line number Diff line change @@ -9,6 +9,34 @@ Tool to extract namespace/functions documentation from Clojure projects into ind
99clojure -X:extract
1010```
1111
12+ # Flow
13+
14+ ``` mermaid
15+ sequenceDiagram;
16+ autonumber
17+ participant C as Config
18+ participant A as Analysis
19+ participant AD as Adapters
20+ participant DB as Datalevin
21+ participant CI
22+ participant RE as Release
23+
24+ C->>A: Read file "resources/config.edn"
25+ A->>A: Parse config projects to download
26+ Note left of A: tools.deps
27+ A->>A: Download projects
28+ Note left of A: clj-kondo
29+ A->>AD: Parse projects function/docs analysis
30+ AD->>DB: Adapts & Indexes data into datoms
31+ DB->>CI: Bulk-transact all datoms
32+ CI->>RE: Zip and Publish
33+ ```
34+
35+ ## Tools used
36+ - [ tools.deps] ( https://github.com/clojure/tools.deps ) Download projects/libraries
37+ - [ clj-kondo] ( https://github.com/clj-kondo/clj-kondo ) Parses/Analyses projects data
38+ - [ datalevin] ( https://github.com/juji-io/datalevin ) Indexing and Storage of the data
39+
1240# Developing
1341
1442## Repl
@@ -25,3 +53,10 @@ clojure -M:dev:test
2553``` bash
2654clojure -T:build uberjar
2755```
56+
57+ # Other iterations
58+ - https://github.com/rafaeldelboni/clojure-document-extractor
59+
60+ # License
61+ This is free and unencumbered software released into the public domain.
62+ For more information, please refer to < http://unlicense.org >
You can’t perform that action at this time.
0 commit comments