Host XLS standards as HTML files for better discoverability and design

XRPLF / xrpl-dev-portal

Source code for xrpl.org including developer documentation

https://xrpl.org

Other

519 stars 1.01k forks source link

Host XLS standards as HTML files for better discoverability and design #1779

Open intelliot opened 1 year ago

intelliot commented 1 year ago

XRPL Standards are harder to discover, and don't look as nice, versus pages on XRPL.org.

For better discoverability and design (than reading on GitHub), we could:

Fetch Markdown files from https://github.com/XRPLF/XRPL-Standards
Host them somewhere under XRPL.org

The result would be comparable to https://eips.ethereum.org/

mDuo13 commented 1 year ago

I think having xls.xrpl.org show nice HTML versions of standards—potentially including supplemental information in separate files—would be nice, and should be plenty doable using GitHub Pages and a GH Action that runs on commit to master. We could use Jekyll, since GH supports that natively, or any other static site generator (e.g. currently XRPL.org uses Dactyl)

amarantha-k commented 1 year ago

+1 to hosting XLS standards as HTML files.
Supplemental information (such as documentation/tutorials) for each proposal will need to be updated frequently during development and hence may be better for contributors to have autonomy on source location/hosting.

alloynetworks commented 1 year ago

The conversations are almost as important as the XLS itself. What is the plan to keep them in sync? I’m not in favor of these coming across as a static document.