Skip to content

docs: better explain the architecture and more clearly separate docker setup from lndmon setup (mermaid version)#124

Merged
djkazic merged 1 commit into
lightninglabs:masterfrom
ZZiigguurraatt:improve_docs_mermaid
Dec 18, 2025
Merged

docs: better explain the architecture and more clearly separate docker setup from lndmon setup (mermaid version)#124
djkazic merged 1 commit into
lightninglabs:masterfrom
ZZiigguurraatt:improve_docs_mermaid

Conversation

@ZZiigguurraatt

Copy link
Copy Markdown
Contributor

This is an alternative to #123 that uses mermaid charts instead of https://app.monosketch.io to diagram the monitoring architecture.

@Roasbeef , @saubyk , @djkazic , please take a look!

@ZZiigguurraatt ZZiigguurraatt changed the title docs: better explain the architecture and more clearly separate docker setup from lndmon setup docs: better explain the architecture and more clearly separate docker setup from lndmon setup, mermaid version Dec 8, 2025
@ZZiigguurraatt ZZiigguurraatt changed the title docs: better explain the architecture and more clearly separate docker setup from lndmon setup, mermaid version docs: better explain the architecture and more clearly separate docker setup from lndmon setup (mermaid version) Dec 8, 2025
@ZZiigguurraatt

Copy link
Copy Markdown
Contributor Author

Looks like it doesn't render well in GitHub "dark mode". Is that an issue for all mermaid charts?

@saubyk saubyk left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Regarding the rendering of mermaid charts in dark mode, you can look up suggestions on any of the LLM tools, it may be improved marginally.

I iterated a lot to improve the mermaid chart on this doc, if it's any help: https://github.com/lightningnetwork/lnd/blob/master/docs/db_migration_guide.md

Comment thread INSTALL.md
@@ -1,88 +0,0 @@
# Table of Contents

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why remove install.md?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The reason I changed the name is because the general install stuff was mostly moved to README.md and everything else related was docker specific.

@Roasbeef Roasbeef left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Favor keeping the name of INSTALL.md, but general doc improvement I'd say. You can get the diagram to render better in dark mode by using different colors.

@ZZiigguurraatt

Copy link
Copy Markdown
Contributor Author

Force pushed a commit that removes a few lines that were added by the web mermaid chart editor I was using. The colors now look good in both light and dark mode.

@ZZiigguurraatt

Copy link
Copy Markdown
Contributor Author

Favor keeping the name of INSTALL.md, but general doc improvement I'd say. You can get the diagram to render better in dark mode by using different colors.

The reason I changed the name is because the general install stuff was mostly moved to README.md and everything else related was docker specific.

@ZZiigguurraatt

Copy link
Copy Markdown
Contributor Author

Who do we need to merge now that @Roasbeef has approved? @djkazic, are you able to do it?

@djkazic djkazic merged commit a6f1e1d into lightninglabs:master Dec 18, 2025
1 check passed
@ZZiigguurraatt ZZiigguurraatt deleted the improve_docs_mermaid branch July 7, 2026 15:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants