Skip to content

Commit

Permalink
docs: Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
liquidz committed Sep 27, 2024
1 parent 017f7e2 commit 1731022
Show file tree
Hide file tree
Showing 11 changed files with 567 additions and 3 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,5 @@ dev/elin/config.edn
doc/graph/component.png
doc/graph/sequence.png
elin-debug.log
doc/pages/generated
target
11 changes: 10 additions & 1 deletion ARCHITECTURE.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@ image:http://www.plantuml.com/plantuml/proxy?src=https://raw.githubusercontent.c

== Basic Policy

* Implement UI-related processing on Vim/Neovim in Vim script.
* Implement UI-related processing on host editor side.
** Vim/Neovim in Vim script.
* Handle interactions with the nREPL server and processing of data received from Vim/Neovim in Clojure (Babashka).
* Implement the Clojure side based on https://github.com/stuartsierra/component[stuartsierra/component].
* Define all settings related to each component explicitly in `resources/config.edn`.
Expand Down Expand Up @@ -41,6 +42,14 @@ image:http://www.plantuml.com/plantuml/proxy?src=https://raw.githubusercontent.c

|===

== Role of elin core

* Connection management with nREPL
* Management of interactions with the editor (Handler)
* Allow behavior of various operations to be modified (Interceptor)

The core will guarantee only these, and additional functionality will be provided through Handlers and Interceptors.

== Plugin

* Purpose
Expand Down
11 changes: 11 additions & 0 deletions bb.edn
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,17 @@
:extra-paths ["dev"]
:task (exec 'elin.task.help/-main)}

generate-document-adoc {:doc "Generate document adoc files"
:extra-paths ["dev"]
:task (do (shell "rm -rf doc/pages/generated")
(exec 'elin.task.doc/-main))}

generate-document-html {:doc "Generate document HTMLs"
:requires ([clojure.java.io :as io])
#_#_:depends [generate-document-adoc]
:task (let [pwd (.getAbsolutePath (io/file "."))]
(shell (str "docker run --rm -v " pwd ":/documents/ asciidoctor/docker-asciidoctor asciidoctor -o target/html/index.html doc/pages/index.adoc")))}

check {:doc "Check all"
:depends [clj-kondo-emit generate-test-analysis generate-deps-edn generate-vim-help
lint format-check test]}
Expand Down
Loading

0 comments on commit 1731022

Please sign in to comment.