search

BitcoinAndLightningLayerSpecs / lsp

API specifications for Lightning Service Providers
MIT License
112 stars 31 forks source link

Add Wiki #105

Closed SeverinAlexB closed 7 months ago

SeverinAlexB commented 8 months ago

This PR is a proposal on how we can use the Github Wiki of this repository for non-normative information. It should store info that is spec related but not worthy of adding to the spec directly. Here is a deployed example. The thought of using the wiki came up earlier but intensified with PR #97 and #98.

What does this PR add?

This PR adds a wiki/ folder. On change, this folder is automatically deployed to the Github Wiki via Github Actions. Any user can change the wiki by creating a PR.

Why can't we edit the wiki directly?

Github Wiki permission management is limited. Only collaborators can edit the wiki. To allow everybody to edit the wiki, this PR auto-syncs the wiki folder with the actual wiki.

Distinction between the main spec

The wiki footer states clearly that the wiki is non-normative and therefore must not be used as an authority to implement the spec.

Who approves wiki content?

Because the wiki is non-normative, we can be more loose approving wiki content. One approval of one of our main contributors should be enough. What do you guys think?

Let me know if you want anything changed.

Sev

ErikDeSmedt commented 8 months ago

Having a space to have non-normative information is a great idea. I like this idea

aljazceru commented 7 months ago

Strong ack!

SeverinAlexB commented 7 months ago

Merge decision in todays meeting