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: new Getting Started page #12196

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

NikitaRevenco
Copy link
Contributor

@NikitaRevenco NikitaRevenco commented Dec 5, 2024

This is a part of a series of pull requests to port the new docs from https://helix-editor.vercel.app into the mdbook

This PR:

  • Ports the "Getting Started" section
  • Adds styles for kbd
  • Adds CSS for custom asides, like aside class="tip". I think this is needed because I'm currently seeing that each "note" is hard coded

my plan at the moment is to make a separate PR for each of the 7 "Getting Started" pages on https://helix-editor.vercel.app one after the other

@the-mikedavis the-mikedavis added the A-documentation Area: Documentation improvements label Dec 5, 2024
@NikitaRevenco NikitaRevenco mentioned this pull request Dec 8, 2024
Copy link
Contributor

@TornaxO7 TornaxO7 left a comment

Choose a reason for hiding this comment

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

Just some smol suggestions.

Hm... one though which I'm getting is: Don't we already have the helix-tutor? In my opinion it sounds a bit troublesome in the future if we have to maintain two "big" tutorials/guides if you know what I mean but on the other more information don't hurt and I think some people prefer a tutorial in the internet. Just my two cents.

book/src/getting-started.md Outdated Show resolved Hide resolved
book/src/getting-started.md Outdated Show resolved Hide resolved
@NikitaRevenco
Copy link
Contributor Author

NikitaRevenco commented Dec 8, 2024

Just some smol suggestions.

Hm... one though which I'm getting is: Don't we already have the helix-tutor? In my opinion it sounds a bit troublesome in the future if we have to maintain two "big" tutorials/guides if you know what I mean but on the other more information don't hurt and I think some people prefer a tutorial in the internet. Just my two cents.

Yeah, I think having two tutorials won't hurt. The helix-tutor is more suitable for the editor than the web, I feel

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-documentation Area: Documentation improvements
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants