docs: better explain the architecture and more clearly separate docker setup from lndmon setup #123
Conversation
|
|
||
| # Architectural Layout | ||
| ``` | ||
| gRPC Server (TCP/10009) ╔══════════════════════╗ |
There was a problem hiding this comment.
Re this and the mono drawing above, you should give mermaid diagrams a shot: https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/creating-diagrams
There was a problem hiding this comment.
thanks, will try that next time, but I think this drawing is good enough for now.
There was a problem hiding this comment.
How are people meant to update this drawing in the future? You've added a new directory that serves no purpose other than to house a .mono file with no instructions on how to render or even update it.
AFAICT, the new folder added isn't even rendered here directly in markdown.
Mermaid markdown diagrams a clearly a better way to check in diagrams into git repos in a way that's universally accessible and extensible.
If I try to view this on a small viewport, the entire diagram is quickly garbled. You can't easily zoom in or move around the diagram.
In 2025, we have much better tools than hand rolled ascii diagrams.
…r setup from lndmon setup
ZZiigguurraatt
force-pushed
the
improve_docs
branch
from
2ed5df1 to
d420608
Compare
|
Waiting on lightninglabs/lightning-terminal#1167 and a review from @djkazic |
OK, lightninglabs/lightning-terminal#1167 has now been merged. |
|
@djkazic , did you still want to review this one? |
|
|
||
| # Architectural Layout | ||
| ``` | ||
| gRPC Server (TCP/10009) ╔══════════════════════╗ |
There was a problem hiding this comment.
How are people meant to update this drawing in the future? You've added a new directory that serves no purpose other than to house a .mono file with no instructions on how to render or even update it.
AFAICT, the new folder added isn't even rendered here directly in markdown.
Mermaid markdown diagrams a clearly a better way to check in diagrams into git repos in a way that's universally accessible and extensible.
If I try to view this on a small viewport, the entire diagram is quickly garbled. You can't easily zoom in or move around the diagram.
In 2025, we have much better tools than hand rolled ascii diagrams.
|
@ZZiigguurraatt, remember to re-request review from reviewers when ready |
|
closing in favor of #124 |
5 participants
Depends on lightninglabs/lightning-terminal#1167
I have not tested the docker stuff, but I think it should be correct.