Dedicated documentation site

[rolznz]

The README is very long and not very readable / developer friendly

Can a docusaurus documentation site be added to the github and the README contents moved there? it should be built as a github action.

[vr-varad]

there is an application known as Docsify where u can convert ur documentation into live website https://docsify.js.org/#/

[vr-varad]

i could work on that

[rolznz]

@vr-varad awesome!

Would we be able to somehow split the documentation for the bitcoin-connect and bitcoin-connect-react packages? and how will the examples be added to the documentation?

I guess we will need to add some more documentation comments in the code, but it would be nice to see a minimal proof of concept of how it looks out of the box.

CC @reneaaron @stackingsaunter

[vr-varad]

ya sure

[vr-varad]

https://bitcoin-connect-3s840lue0-varad-guptas-projects.vercel.app/#/ i made a simple docsify website using readme of bitcoin-connect I just used the readme this is the basic we can also make the side panel more interactive i.e we can add accordian, logo etc please give it a look and the repo https://github.com/vr-varad/bitcoin_connect_example.git

[vr-varad]

u can give it a look @rolznz

[vr-varad]

@rolznz what are ur thoughts on this

[rolznz]

@vr-varad sorry, I cannot access the vercel link - it asks me to login. Can you make it public?

[vr-varad]

https://bitcoin-connect-exp.vercel.app/#/ Try this @rolznz This can be formated more as per wish.

[rolznz]

@vr-varad thanks, it works now. I like the sidebar, but it is still a huge long page of documentation.

The goal here is to make simple documentation that is easy to follow - not a single large document like the README currently is.

[vr-varad]

I am working on that only will let u know in an hour or two.

[vr-varad]

https://bitcoin-connect-exp.vercel.app/#/ try this i tried to differentiate the pages let me know what changes can me know

[rolznz]

@vr-varad cool!

Is this possible to run with github pages as a static site? do you think you could do a minimal fork of bitcoin connect with these changes so we don't need to host it on vercel?

sections like https://bitcoin-connect-exp.vercel.app/#/./bitcoinConnectAPI/README are way too large - can they be split into subpages?

The sections are not split very logically, but if we decide to go with this approach I can provide an exact list for you.

I would also put the banner back on the home page, and maybe use a different image for the sidebar.

And also, there seem to be some empty pages committed and the naming of the routes could be improved.

I will try to get some feedback from the team.

[vr-varad]

that would be good. please let me know;) but if you need more freedom with design we can go with building it in ReactJS or HTML/CSS/JS. that would give us more freedom in terms of design, orientations, and the URL specifically

[rolznz]

@vr-varad did you also look at any other tools? what about docusaurus? from the comparison it has some advantages over docsify. https://docusaurus.io/docs#comparison-with-other-tools

[vr-varad]

ya this looks better to me if u want i will start working on it??

[rolznz]

@vr-varad if you are happy to, that would be great!

[rolznz]

Maybe doing just a proof of concept would be simpler so it's easy to review - add a sidebar/navigation with just two or or three pages.

Could you do this in a fork directly off https://github.com/getAlby/bitcoin-connect and make a pages workflow at the same time?

[vr-varad]

sorry for being late @rolznz https://65e4a924dd2735ae17e18667--deft-pasca-6e00f8.netlify.app/ this i made using docasaurus i tried my best let me know if anything to change.

[rolznz]

Hi @vr-varad can you please make sure you can run it on github pages, and then share the github link?

There is no need to add a landing page since we already have one here: https://bitcoin-connect.com/

Also, the sidebar items are quite strange - why is "docs" in a separate section that has to be expanded?

I would have items like:

• Introduction
• Migration Guide
• Quick Start
  • React
  • Javascript
  • HTML (CDN)
• Usage
  • React
  • NextJS
  • Other frameworks
  • Javascript
• Bitcoin Connect API
  • (Each method as subitems)
• Demos
  • (each individual demo as subitems)
• FAQ
  • (each individual question as subitems)
• Development
• Contact

[vr-varad]

Ok, no problem @rolznz I will work on that actually this was just a demo to showcase what it would look like. I will start working on that.

[vr-varad]

hey @rolznz https://bitcoin-connect-docs.netlify.app/ I have made the necessary changes need confirmation from u and then will deploy on GitHub pages If there are any changes needed let me know

[rolznz]

Thanks @vr-varad - this is great! There are still some things to fix, but I can give you follow-up feedback for that.

The reason I asked about github pages and a PR on bitcoin-connect directly is because we need to evaluate the amount of changes and whether this is something we can maintain long-term. So this is the most important thing right now.

[vr-varad]

I can understand, it will be done by today.

[vr-varad]

@rolznz I created the pr regarding the deploy folder plz check it out and leave a review. Regards