joinmarket-clientserver icon indicating copy to clipboard operation
joinmarket-clientserver copied to clipboard

Missing table of contents in the Readme page.

Open Nik-09 opened this issue 2 years ago • 3 comments

Table of contents missing in the top of the readme file, adding a table of contents on the top of the readme file will help in the following:

  1. Give a quick summary of what are the contents present on the page.
  2. Quickly access any resources without scrolling to the bottom.

Thank you.

Nik-09 avatar Feb 04 '22 05:02 Nik-09

Before working on it I would like @AdamISZ to take a look into the issue and suggest if any other changes can be added with this.

Thank you.

Nik-09 avatar Feb 04 '22 06:02 Nik-09

I suppose it's debatable, but yes adding a table of contents is a pretty good idea, thanks.

Another thing we should add to the README is a link to this new github pages hosting of the documentation:

https://joinmarket-org.github.io/joinmarket-clientserver/

and in particular the documentation of our new RPC-API:

https://joinmarket-org.github.io/joinmarket-clientserver/api/

AdamISZ avatar Feb 05 '22 16:02 AdamISZ

Thank you @AdamISZ for confirming, I will create a pr by end of 7th Feb.

Nik-09 avatar Feb 06 '22 05:02 Nik-09