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

docs: add editPageLink in demo #343

Merged
merged 5 commits into from
Sep 23, 2024
Merged

Conversation

Charan167
Copy link
Contributor

Recording.2024-09-21.193033_compressed.mp4
  • Added editPageLink to demo lessons

Copy link

stackblitz bot commented Sep 21, 2024

Review PR in StackBlitz Codeflow Run & review this pull request in StackBlitz Codeflow.

@Charan167 Charan167 changed the title feat: Add editPageLink in demo lessons feat: add editPageLink in demo lessons Sep 23, 2024
Copy link
Member

@AriPerkkio AriPerkkio left a comment

Choose a reason for hiding this comment

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

Great work @Charan167!

While this already works really nicely, we can reduce the amount of code by defining it only in top-level metadata, here:

---
type: tutorial
mainCommand: ['npm run dev', 'Starting http server']
prepareCommands:
- ['npm install', 'Installing dependencies']
---

So looking at your code, I think something like this could work there:

---
editPageLink: https://github.com/stackblitz/tutorialkit/blob/main/docs/demo/src/content/tutorial/${path}?plain=1
---

The ${path} here is dynamic parameter that TutorialKit will automatically apply there per-lesson.

@Charan167
Copy link
Contributor Author

@AriPerkkio Forgive my noobness 😅. Please let me know if any more changes are needed. Also, feel free to let me know if you need help with any other issues—I'd be more than happy to work on them.

Copy link
Member

@AriPerkkio AriPerkkio left a comment

Choose a reason for hiding this comment

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

Looks good, thanks @Charan167!

Also, feel free to let me know if you need help with any other issues—I'd be more than happy to work on them.

Awesome! Maybe these issues could be good next?

@AriPerkkio AriPerkkio changed the title feat: add editPageLink in demo lessons docs: add editPageLink in demo Sep 23, 2024
@AriPerkkio AriPerkkio merged commit fb5c38c into stackblitz:main Sep 23, 2024
11 checks passed
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