Skip to content

Migrate to Vuepress - #46

Merged
dennisreimann merged 10 commits into
developfrom
vuepress
Jul 7, 2021
Merged

dennisreimann merged 10 commits into
developfrom
vuepress

Conversation

@dennisreimann

@dennisreimann dennisreimann commented Jun 29, 2021 •

Copy link
Copy Markdown
Collaborator

This PR contains the basic migration and design adaptions. Implementation of the design isn't fully done yet, but this covers the basics so that the docs look good and are usable already .

The intention of getting the basics out was to prevent conflicts in case the docs are being worked on currently. We can discuss how to proceed and whether or not we want to already merge it to main or wait until everything is done in full. The alternative would be to create a development branch and target this with several migration PRs.

Once we merge to main, the GitHub Actions workflow will take care of deploying the docs via GitHub Pages. After having it live, we can apply for Algolia Docsearch, which will be a major enhancement of the search. The current search just covers the headline content, Algolia does fulltext search.

The linkcheck failure is due to a bug in rustc, the referenced docs don't build currently. Matt said we'll wait for them to fix that bug.

@netlify

netlify Bot commented Jun 29, 2021 •

Copy link
Copy Markdown

✔️ Deploy Preview for ldk-docs-preview ready!

🔨 Explore the source changes: 450ff1e

🔍 Inspect the deploy log: https://app.netlify.com/sites/ldk-docs-preview/deploys/60e1a2a978cab60007ea2a58

😎 Browse the preview: https://deploy-preview-46--ldk-docs-preview.netlify.app

@valentinewallace

valentinewallace commented Jun 29, 2021 •

Copy link
Copy Markdown
Collaborator

Hmm, so it's important that it's very easy and obvious for people to get to the "Build a Node" guides. Maybe we could replace the "Getting Started" tab with a "Guides" tab (here), that goes straight to the Build a Node in Java guide? (and have the Rust guide and these other guides:
image
listed below in the big white space here).

Then the "Use Cases" page could go in the big white gap here.

Open to any ideas though!

@valentinewallace

Copy link
Copy Markdown
Collaborator

So, for the code samples in the guide, could we allow 80 characters before having a horizontal scroll bar? On the current website, 80 characters fit: https://i.imgur.com/a4gmAVM.png but on the new website, there's currently a scrollbar even when I have the window maximized: https://i.imgur.com/b87pvtv.png

@valentinewallace

Copy link
Copy Markdown
Collaborator

Bit picky, but in the current website's dark mode, code stuff has a cool "highlight": https://i.imgur.com/Slhb769.png vs it doesn't seem like the new website has that: https://i.imgur.com/a0SE3ia.png

@dennisreimann

Copy link
Copy Markdown
Collaborator Author

@valentinewallace Thanks for the feedback. I've addressed the mentioned points and added a proper sidebar, which now contains the links to the general docs and guides.

@valentinewallace

Copy link
Copy Markdown
Collaborator

Thank you Dennis, will give this another review today

@valentinewallace

Copy link
Copy Markdown
Collaborator

This looks really good! Just a few minor nits:

@dennisreimann

Copy link
Copy Markdown
Collaborator Author

@valentinewallace Updated according to your points :)

@dennisreimann
dennisreimann changed the base branch from main to develop July 7, 2021 06:51
@dennisreimann
dennisreimann merged commit d38bf66 into develop Jul 7, 2021
@dennisreimann
dennisreimann deleted the vuepress branch July 7, 2021 06:52
dennisreimann added a commit that referenced this pull request Jul 9, 2021
* Migrate to Vuepress

* Styling updates

* Format titles for Vuepress

* Add navigation sidebar

* Improve sidebar styling

* Ignore linkcheck failures for now

* Remove introduction from homepage

* Style improvements

* Wording and content modifications

* Add favicon files
dennisreimann added a commit that referenced this pull request Jul 20, 2021
* Migrate to Vuepress

* Styling updates

* Format titles for Vuepress

* Add navigation sidebar

* Improve sidebar styling

* Ignore linkcheck failures for now

* Remove introduction from homepage

* Style improvements

* Wording and content modifications

* Add favicon files
dennisreimann added a commit that referenced this pull request Jul 29, 2021
* Migrate to Vuepress

* Styling updates

* Format titles for Vuepress

* Add navigation sidebar

* Improve sidebar styling

* Ignore linkcheck failures for now

* Remove introduction from homepage

* Style improvements

* Wording and content modifications

* Add favicon files
dennisreimann added a commit that referenced this pull request Aug 4, 2021
* Migrate to Vuepress

* Styling updates

* Format titles for Vuepress

* Add navigation sidebar

* Improve sidebar styling

* Ignore linkcheck failures for now

* Remove introduction from homepage

* Style improvements

* Wording and content modifications

* Add favicon files
dennisreimann added a commit that referenced this pull request Aug 16, 2021
* Migrate to Vuepress

* Styling updates

* Format titles for Vuepress

* Add navigation sidebar

* Improve sidebar styling

* Ignore linkcheck failures for now

* Remove introduction from homepage

* Style improvements

* Wording and content modifications

* Add favicon files
dennisreimann added a commit that referenced this pull request Aug 24, 2021
* Migrate to Vuepress

* Styling updates

* Format titles for Vuepress

* Add navigation sidebar

* Improve sidebar styling

* Ignore linkcheck failures for now

* Remove introduction from homepage

* Style improvements

* Wording and content modifications

* Add favicon files
dennisreimann added a commit that referenced this pull request Sep 2, 2021
* Migrate to Vuepress

* Styling updates

* Format titles for Vuepress

* Add navigation sidebar

* Improve sidebar styling

* Ignore linkcheck failures for now

* Remove introduction from homepage

* Style improvements

* Wording and content modifications

* Add favicon files
dennisreimann added a commit that referenced this pull request Oct 5, 2021
* Migrate to Vuepress

* Styling updates

* Format titles for Vuepress

* Add navigation sidebar

* Improve sidebar styling

* Ignore linkcheck failures for now

* Remove introduction from homepage

* Style improvements

* Wording and content modifications

* Add favicon files
dennisreimann added a commit that referenced this pull request Oct 7, 2021
* Migrate to Vuepress (#46)

* Migrate to Vuepress

* Styling updates

* Format titles for Vuepress

* Add navigation sidebar

* Improve sidebar styling

* Ignore linkcheck failures for now

* Remove introduction from homepage

* Style improvements

* Wording and content modifications

* Add favicon files

* Upgrade dependencies

* Decrease sidebar depth

* Fix logo in Firefox

* Set selection styles

* Minor style fixes

* Attempt to fix font issue

* Import Manrope from Google Fonts

* Don't show headings in sidebar

* Add blog

* Update blog sidebar

* Add pitch points to homepage

* Homepage style tweaks

* Fix blog article sidebar

* Add card image

* Improve 404 page

* Component improvements

* Add footer

Closes  #61

* Add features to homepage

Closes #62

* Update feature list on homepage

* Fix after rebase

* Fix theme switch icon size on iOS

* Stylus fixes

* Upgrade dependencies

* Update theme colors

Closes #60

* Restructure sidebar nav for docs pages

* Create different sidebar for tutorial page, break some docs up into new pages

* Styling updates

* Fix tab behaviour

Closes #72

* Fix note

* Updates features section copy

* Remove overview page from footer

* Add copy for high performance & compact feature

* Include Electrum explicitly

* Remove doc deep links temporarily

* Include IoT and PoS devices

* Shorten copy

* Decrease sidebar width

* Update logo

* Update colors and logo

* Update ignore file

* Add footnote plugin

* Improve iframe integration

* Remove BDK blog posts

* Extract theme

* Fix body bg color

* Update theme and variables

* Upgrade dependencies

* Update theme

* Update tagline

* Fixes broken links

* Blog coming soon

* Update footer link

* Update code and note colors

* Fix links

* Add SEO config

* Update favicon

* Copy updates

Co-authored-by: ConorOkus <conor.okus@hotmail.co.uk>
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

Successfully merging this pull request may close these issues.

2 participants