Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adds getting started installation instructions #133

Merged
merged 6 commits into from
Jul 19, 2022

Conversation

ConorOkus
Copy link
Contributor

@ConorOkus ConorOkus commented Jul 4, 2022

@netlify
Copy link

netlify bot commented Jul 4, 2022

Deploy Preview for lightningdevkit ready!

Name Link
🔨 Latest commit e1513d6
🔍 Latest deploy log https://app.netlify.com/sites/lightningdevkit/deploys/62d5cce4bef654000808edbd
😎 Deploy Preview https://deploy-preview-133--lightningdevkit.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@ConorOkus ConorOkus force-pushed the getting-started branch 3 times, most recently from a176cda to bab6603 Compare July 11, 2022 09:13
@jurvis
Copy link

jurvis commented Jul 12, 2022

No need to hold this PR up, but I think we're getting close over at ldk-swift land to make a presence in this page too.

I'll submit a PR when we're ready :)

docs/tutorials/getting-started.md Outdated Show resolved Hide resolved
docs/tutorials/getting-started.md Outdated Show resolved Hide resolved
Comment on lines 80 to 81
Example usage after installation is complete:
:::: tabs
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would be great if the language tabs here and the previous box were synced. I think that had been done in one of the guides when we had more than one example per page prior to breaking it up into subpages.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

cc @dennisreimann seems like it's possible on page load but not when you actually click a single tab?

Copy link
Contributor Author

@ConorOkus ConorOkus Jul 14, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It does kinda work with anchor links e.g tutorials/getting-started/#java but does this weird page jump

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ran across this which may help? vuejs/vuepress#851 (comment)

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jkczyz Thanks for the pointer, I've migrated to the code switcher plugin in #139.

docs/tutorials/getting-started.md Outdated Show resolved Hide resolved
docs/tutorials/getting-started.md Outdated Show resolved Hide resolved
docs/tutorials/getting-started.md Outdated Show resolved Hide resolved
@dennisreimann dennisreimann mentioned this pull request Jul 15, 2022
@ConorOkus
Copy link
Contributor Author

Thanks for the CodeSwitcher recommendation @jkczyz. Updated in b1d8e31

@jkczyz
Copy link
Collaborator

jkczyz commented Jul 18, 2022

Thanks for the CodeSwitcher recommendation @jkczyz. Updated in b1d8e31

Looks good modulo a formatting nit.

Comment on lines +12 to +15
<CodeSwitcher :languages="{rust:'Rust', java:'Java', kotlin:'Kotlin', javascript:'JavaScript'}">
<template v-slot:rust>

```toml
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Indentation levels seem inconsistent across the first CodeSwitcher block, FWIW. The second block seems fine though with two spaces and one within the formatted language blocks.

@ConorOkus ConorOkus merged commit df54c90 into lightningdevkit:main Jul 19, 2022
@ConorOkus ConorOkus deleted the getting-started branch July 19, 2022 23:20
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.

None yet

4 participants