Skip to content

doc(tutorial): clean up minor typos/grammar issues in index #653

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

doc(tutorial): clean up minor typos/grammar issues in index #653

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions docs/tutorial/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,9 @@ import { code, testcases } from './data'

# Welcome to Elysia

It's great to have you here! This playground is will help you get started with Elysia interactively.
It's great to have you here! This playground will help you get started with Elysia interactively.

Unlike traditional backend framework, **Elysia can also run in a browser** as well! Although it doesn't support all features, it's a perfect environment for learning and experimentation.
Unlike traditional backend frameworks, **Elysia can also run in a browser**! Although it doesn't support all features, it's a perfect environment for learning and experimentation.

You can check out the API docs by clicking <Bookmark class="inline" :size="18" stroke-width="2" /> on the left sidebar.

Expand All @@ -40,29 +40,29 @@ Elysia is an ergonomic framework for humans.

Ok, seriously, Elysia is a backend TypeScript framework that focuses on developer experience and performance.

What makes Elysia different from other frameworks is that:
What makes Elysia different from other frameworks is:

1. Spectacular performance comparable to Golang.
2. Extraordinary TypeScript support with **type soundness**.
3. Built around OpenAPI from the ground up.
4. Offers End-to-end Type Safety like tRPC.
5. Use Web Standard, allows you to run your code anywhere like Cloudflare Workers, Deno, Bun, Node.js and more.
5. Uses Web Standards, allowing you to run your code anywhere like Cloudflare Workers, Deno, Bun, Node.js and more.
6. It is, of course, **designed for humans** first.

Although Elysia has some important concept but once get the hang of it, many people find it very enjoyable, and intuative to work with.
Although Elysia has some framework-specific concepts to learn, once users get the hang of it, many find it very enjoyable and intuitive to work with.
Copy link
Author

Choose a reason for hiding this comment

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

I wasn't sure exactly what was meant here, but I think this might be right?


## How to use this playground

Playground is divided into 3 sections:
1. Documentation and task on the left side (you're reading).
1. Documentation and task on the left side (what you're currently reading).
2. Code editor in the top right
3. Preview, output, and console in the bottom right

## Assignment

As for the first assignment, let's modify the code to make the server respond with `"Hello Elysia!"` instead of `"Hello World!"`.
For the first assignment, let's modify the code to make the server respond with `"Hello Elysia!"` instead of `"Hello World!"`.

Feels free to look around the code editor and preview section to get familiar with the environment.
Feel free to look around the code editor and preview section to get familiar with the environment.

<template #answer>

Expand All @@ -77,7 +77,7 @@ new Elysia()
.listen(3000)
```

This would make Elysia response with `"Hello Elysia!"` when you access `/`.
Now Elysia will respond with `"Hello Elysia!"` when you access `/`.

</template>

Expand Down