Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Protocol Docs in single repo #233

Open
st3b1t opened this issue Oct 9, 2023 · 0 comments
Open

Protocol Docs in single repo #233

st3b1t opened this issue Oct 9, 2023 · 0 comments

Comments

@st3b1t
Copy link
Contributor

st3b1t commented Oct 9, 2023

I think it is a sensible idea to separate protocol specification documentation from this repository that accept PR also from any(exotics) projects/coin, one list some good reasons for this:

  1. the protocol should be implementation agnostic
  2. the documentation that exists along with the code might have been fine in the early days of the project
  3. there may be new protocol specifications that electrumx may never be able to implement(the project seems to me to be inactive compared to others)
  4. a dedicated repository would give greater visibility and dignity to the protocol specification
  5. it would be easier to manage PR and protocol-specific ideas that have little to do with the specific implementation
  6. it would all make more sense and clear in the eyes of new contributors
@st3b1t st3b1t changed the title Protocol Specs to a separate repo Protocol Specs in separate repo Oct 9, 2023
@st3b1t st3b1t changed the title Protocol Specs in separate repo Protocol Docs in separate repo May 13, 2024
@st3b1t st3b1t changed the title Protocol Docs in separate repo Protocol Docs in single repo May 13, 2024
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

No branches or pull requests

1 participant