thebrandonlucas
commented
5 months ago After discussion with @DanGould, it was agreed to revert any copy changes and and not to introduce any new content changes, so that this PR can instead focus on underlying structural changes to docusaurus to the extent possible, to reduce the amount of changes being introduced in one PR. However, since this is a major structural change to the underlying website code, this having many changes at once is inevitable to an extent.
To that end, I kept the content nearly exactly the same as the current website. The homepage remains mostly the same, with the following changes:
- The navbar is a bit different now due to docusaurus default styling. All the links are the same with the addition of a link to our GitHub page.
- Some slight changes to the copy style (using defaults)
- New (default docusaurus) footer, content kept the same
- Removed supported/unsupported wallets table (we can re-add later if we choose to do so, but should probably find a way to keep it in sync with the Payjoin wiki when/if we decide to redo it)
- Added redirects for the three routes we had at
/lightning,/scale,/privacyfor backward-compatibility - The
/lightning,/scale,/privacyarticles as well as the FAQ are now located at/docs, which is what you get when you click "Learn" in the navbar.
Overall, I think this move will allow us to focus on the bigger picture and iterate on content much faster and not get stuck in minutiae of styling & design decisions. Docusaurus still allows a great deal of flexibility if we choose to do that.
I have tested all the links myself and they look good, let me know what you think!
DanGould
This is a massive PR change to completely restructure the site to use docusaurus, a docs-site generator with all sorts of built-in bells and whistles that is commonly used and familiar. It allows us to write our articles in markdown and handles routing/rendering automatically. I kept the home page as mostly the same as our current payjoin.org site with some enhancements (and removed a couple other things). I've also been using excalidraw to create explainer diagrams for payjoin v1/v2. You can see them all here.
This PR is not yet complete as I think we should write a couple of tutorials on how to use it (especially payjoin v2) as well as write some articles on building a send/receive payjoin. We can also discuss whether we want to port over PDK to this website and make it it's own dedicated page with tutorials and navigation (it can have it's own homepage on the same site, etc.) or whether we think it's better to keep them separate. I personally favor integrating everything we can for ease of access unless we feel the site is getting hard to navigate, but generally we should try to funnel people from very high level -> very technical in a naturally progressive way, which this docs site is designed to handle well. PDK website doesn't have much on it currently that would require porting, and I notice the actual API docs are outsourced to the rust documentation anyway, so we wouldn't be losing much in the port and would probably gain navigability.
We can also consider just putting the blog (or a blog) on payjoin updates on here, as well as podcast appearances, news, video tutorials, etc. Docusaurus comes with a sample blog built-in for reference, I think that would fit well here.
This took a lot of inspiration from fedimint's setup. I like a lot about how that project is setup, in addition, their Github is also very well organized.
Overall, this change will make it much easier for us to iterate on documentation and educational materials. Let me know what you think.