vincenzopalazzo
/
rgb-cln
1
0
Fork 0
Code Issues 1 Pull Requests Packages Projects Releases Wiki Activity
rgb-cln/doc/getting-started/home.md

21 lines
31 KiB
Markdown
Raw Normal View History

doc: Add guides and GitHub workflow for doc sync This PR: - adds all the guides (in markdown format) that is published at https://docs.corelightning.org/docs - adds a github workflow to sync any future changes made to files inside the guides folder - does not include API reference (json-rpc commands). Those will be handled in a separate PR since they're used as manpages and will require a different github workflow Note that the guides do not exactly map to their related files in doc/, since we reorganized the overall documentation structure on readme for better readability and developer experience. For example, doc/FUZZING.md and doc/HACKING.md#Testing are merged into testing.md in the new docs. As on the creation date of this PR, content from each of the legacy documents has been synced with the new docs. Until this PR gets merged, I will continue to push any updates made to the legacy documents into the new docs. If this looks reasonable, I will add a separate PR to clean up the legacy documents from doc/ (or mark them deprecated) to avoid redundant upkeep and maintenance. Changelog-None
2023-04-22 14:21:44 +01:00
---
title: "Welcome to Core Lightning Documentation Portal"
slug: "home"
excerpt: "Here you can find everything you need to jump-start your journey to running and building on Core Lightning."
hidden: false
createdAt: "2023-01-30T15:53:40.926Z"
updatedAt: "2023-02-13T15:43:05.463Z"
---
> 📘 Help us improve!
>
> The Core Lightning documentation and API reference is a work-in-progress, feel free to suggest edits or send us your feedback by clicking on **_Suggest Edits_** at the top-right of every page (_login required_) or via **[Telegram](https://t.me/lightningd)**.
***
[block:html]
{
"html": "<div class=\"homeContent\">\n \t<h1 style=\"margin-top: -20px;\"></h1>\n <p> </p>\n <h2>Getting Started</h2>\n <div class=\"navGrid\">\n <!-- \n <a href=\"https://blockstream-core-lightning.readme.io/docs/hardware-considerations\" class=\"navItem\">\n <svg id=\"Layer_2\" xmlns=\"http://www.w3.org/2000/svg\" viewBox=\"0 0 90 90\">\n <defs><style>.cls-1{fill:#fff;}.cls-2{fill:#dfb316;}</style></defs><g id=\"Layer_1-2\"><g><circle class=\"cls-2\" cx=\"45\" cy=\"45\" r=\"45\"/><path class=\"cls-1\" d=\"M24.15,68.96h41.71c1.71,0,3.1-1.39,3.1-3.1V24.15c0-1.71-1.39-3.1-3.1-3.1H24.15c-1.71,0-3.1,1.39-3.1,3.1v41.71c0,1.71,1.39,3.1,3.1,3.1Zm-1.07-44.81c0-.59,.48-1.07,1.07-1.07h41.71c.59,0,1.07,.48,1.07,1.07v41.71c0,.59-.48,1.07-1.07,1.07H24.15c-.59,0-1.07-.48-1.07-1.07V24.15Z\"/><path class=\"cls-1\" d=\"M29.36,30.91c.85,0,1.55-.7,1.55-1.55s-.7-1.55-1.55-1.55-1.55,.7-1.55,1.55,.7,1.55,1.55,1.55Z\"/><path class=\"cls-1\" d=\"M29.36,62.19c.85,0,1.55-.7,1.55-1.55s-.7-1.55-1.55-1.55-1.55,.7-1.55,1.55,.7,1.55,1.55,1.55Z\"/><path class=\"cls-1\" d=\"M60.64,30.91c.86,0,1.55-.7,1.55-1.55s-.7-1.55-1.55-1.55-1.55,.7-1.55,1.55,.7,1.55,1.55,1.55Z\"/><path class=\"cls-1\" d=\"M60.64,59.09c-.85,0-1.55,.7-1.55,1.55s.7,1.55,1.55,1.55,1.55-.7,1.55-1.55-.7-1.55-1.55-1.55Z\"/><path class=\"cls-1\" d=\"M45,60.62c8.61,0,15.62-7.01,15.62-15.62s-7.01-15.62-15.62-15.62-15.62,7.01-15.62,15.62,7.01,15.62,15.62,15.62Zm-4.14-15.59s0,.08,0,.12l.02,.74-8.78,3.52-.29-1.2c-.27-1.08-.4-2.17-.4-3.22s.13-2.14,.4-3.22l.29-1.2,8.78,3.53-.02,.74s0,.08,0,.12v.06Zm-5.24,9.78l-.89-.85,7.45-5.85,.64,.41s.06,.03,.1,.06l.79,.44-1.34,9.37-1.18-.34c-2.08-.61-4.01-1.72-5.58-3.23Zm6.23-9.8c0-1.74,1.41-3.15,3.15-3.15s3.15,1.41,3.15,3.15-1.41,3.15-3.15,3.15-3.15-1.41-3.15-3.15Zm13.42,8.95l-.89,.85c-1.57,1.51-3.5,2.62-5.58,3.22l-1.18,.34-1.34-9.37,.81-.45s.07-.04,.1-.06l.63-.39,7.44,5.84Zm-8.99-12.94l1.34-9.39,1.18,.34c2.08,.61,4.01,1.72,5.58,3.23l.89,.85-7.44,5.84-.63-.39s-.08-.05-.15-.08l-.76-.4Zm-5.08-9.04l1.18-.34,1.34,9.37-.8,.44s-.08,.04-.12,.06l-.63,.38-7.43-5.84,.89-.85c1.57-1.5,3.5-2.62,5.58-3.23Zm7.94,13s0-.07,0-.11l-.03-.75,8.79-3.53,.29,1.2c.26,1.09,.4,2.17,.4,3.22s-.13,2.13-.4,3.22l-.29,1.2-8.79-3.53,.03-.75s0-.07,0-.11v-.06Z\"/></g></g>\n </svg>\n <h4>Hardware considerations</h4>\n <p>A lightning node requires reasonable amount of memory and storage. Learn what's suitable for your scenario.</p>\n </a>\n\t\t -->\n <a href=\"https://blockstream-core-lightning.readme.io/docs/installation\" class=\"navItem\">\n <svg id=\"Layer_2\" xmlns=\"http://www.w3.org/2000/svg\" viewBox=\"0 0 90 90\">\n <defs><style>.cls-1{fill:#fff;}.cls-2{fill:#dfb316;}</style></defs><g id=\"Layer_1-2\"><g><circle class=\"cls-2\" cx=\"45\" cy=\"45\" r=\"45\"/><rect class=\"cls-1\" x=\"20.53\" y=\"65.69\" width=\"48.93\" height=\"2.28\"/><polygon class=\"cls-1\" points=\"63.76 44.17 62.32 42.41 46.5 55.73 46.5 19.92 44.22 19.92 44.22 56.14 28.39 42.41 26.85 44.18 45.06 59.92 63.76 44.17\"/></g></g>\n </svg>\n <h4>Installation</h4>\n <p>Core lightning is available on many platforms and environments. Learn how to install on your preferred platform.</p>\n </a>\n <a href=\"https://blockstream-core-lightning.readme.io/docs/configuration\" class=\"navItem\">\n <svg id=\"Layer_2\" xmlns=\"http://www.w3.org/2000/svg\" viewBox=\"0 0 90 90\">\n <defs><style>.cls-1{fill:#fff;}.cls-2{fill:#dfb316;}</style></defs><g id=\"Layer_1-2\"><g><circle class=\"cls-2\" cx=\"45\" cy=\"45\" r=\"45\"/><path class=\"cls-1\" d=\"M45,56.63c6.41,0,11.63-5.22,11.63-11.63s-5.22-11.63-11.63-11.63-11.63,5.22-11.63,11.63,5.22,11.63,11.63,11.63Zm0-21.09c5.21,0,9.45,4.24,9.45,9.46s-4.24,9.46-9.46,9.46h0c-5.21,0-9.45-4.24-9.45-9.46s4.24-9.46,9.46-9.46Z\"/><path class=\"cls-1\" d=\"M26.32,50.6c.39,1.28,.89,2.51,1.51,3.65l.11,.2-2.94,4.89,5.67,5.67,4.89-2.94,.2,.11c1.15,.62,2.37,1.13,3.65,1.51l.21,.06,1.38,5.54h8.01l1.38-5.54,.22-.06c1.28-.38,2.51-.89,3.65-1.51l.2-.11,4.89,2.94,5.67-5.67-2.94-4.89
}
[/block]