Skip to content

[WIP] Updated docs content for new editor experience #194

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

Open
wants to merge 33 commits into
base: main
Choose a base branch
from
Open
Changes from 1 commit
Commits
Show all changes
33 commits
Select commit Hold shift + click to select a range
43b5630
Initial re-ordering of content
auchenberg Jan 16, 2024
2bb256a
Re-organize partials and images
auchenberg Jan 16, 2024
9b778e5
Inline What's Codeflow content
auchenberg Jan 16, 2024
f2a8c7a
Merge content from Codeflow FAQ into general FAQ
auchenberg Jan 16, 2024
fe7d6a7
Fix image
auchenberg Jan 16, 2024
e1c7891
Fix broken path
auchenberg Jan 16, 2024
4199b80
Inline missing content
auchenberg Jan 16, 2024
08ed5f1
Add missing images for Web Publisher docs integration
auchenberg Jan 16, 2024
5782147
Fix broken images
auchenberg Jan 16, 2024
d0e3e0f
Add missing images for Integrating CodeflowApp Bot
auchenberg Jan 16, 2024
d03db99
New editor docs
auchenberg Jan 16, 2024
7121a05
Stackblitz IDE -> Stackblitz editor
auchenberg Jan 16, 2024
40dfddb
Whats on your screen -> User interface
auchenberg Jan 16, 2024
d57e663
Begin to update Working in editor content
auchenberg Jan 16, 2024
72a2010
Fix dead links
auchenberg Jan 16, 2024
f3d1af8
Begin to get rid of more Codeflow branding
auchenberg Jan 16, 2024
46756d9
update codeflow app page
Jan 16, 2024
598aaff
update faqs
peter-zawistowicz Jan 18, 2024
b03d0f3
update getting-started
peter-zawistowicz Jan 18, 2024
436c467
Updates to the API work spaces
HeyGarrison Jan 22, 2024
c3fb175
Merge branch 'main' into auchenberg/new-editor-docs
HeyGarrison Jan 29, 2024
9b12bb6
fixing typos for Stackblitz.
HeyGarrison Jan 29, 2024
cd4e046
removing "StackBlitz editor"
HeyGarrison Jan 29, 2024
d897982
adding in classic editor part
HeyGarrison Jan 29, 2024
1f33c50
forgot http post
HeyGarrison Jan 29, 2024
d25e870
Title changes to help users understand
HeyGarrison Jan 30, 2024
528815c
removing mentioned of code flow and reworking copy
HeyGarrison Feb 6, 2024
756a0f7
Making getting started / quick start more prominen
HeyGarrison Feb 7, 2024
9f3bede
Fixing broken images
HeyGarrison Feb 8, 2024
5e79262
More removals of codeflow
HeyGarrison Feb 8, 2024
981d77b
fixing quick start
HeyGarrison Feb 9, 2024
2532507
Merge branch 'main' of github.com:stackblitz/docs into auchenberg/new…
HeyGarrison Feb 21, 2024
1a33004
Merge branch 'main' into auchenberg/new-editor-docs
HeyGarrison Feb 28, 2024
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
Prev Previous commit
Next Next commit
removing mentioned of code flow and reworking copy
  • Loading branch information
HeyGarrison committed Feb 6, 2024
commit 528815cfb45333f1a4f2c6a844d1557314f83cea
41 changes: 17 additions & 24 deletions docs/guides/user-guide/what-is-stackblitz.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,20 +14,21 @@ Now you can use the web to build the web.

StackBlitz is secure, shareable, and satisfying.

There is no greater buzzkill than having to fiddle with the deployment and build tools config before you can start coding. **StackBlitz takes care of all of the setup**: from forking and installing dependencies to configuring build tools and hot reloading. Working on StackBlitz feels exactly like working on your local dev environment - minus the frustrating parts.
There is no greater buzzkill than having to fiddle with the cloning and installing before you can start coding. **StackBlitz takes care of all of the setup**: from instantly cloning and installing dependencies to configuring build tools and hot reloading. The beauty of StackBlitz is that it just works.

### Key features:

- 🔒 **unmatched security**: all development is happening in your browser tab, including running Node.js, git, package managers (npm, yarn, pnpm), and local extensions.
- ⚡️ **shockingly fast**: the entire dev environment spins up in milliseconds - even reinstalling `node_modules` is as simple as refreshing the page, with pnpm running up to four times as fast as locally!
- 💻 **works online and offline**: continue your work even when you lose the Internet connection midway.
- 🔥 **your environment is always online**: your apps never go to sleep and have no bandwidth limits - share the URL with as many friends, colleagues, and communities as you’d like!
- 🆓 **always free for Open Source**: you're the future of the web development and we love you.
- **seamless debugging** with Chrome Dev Tools for both front- and backend apps!
- ⚡️ **Shockingly fast**: The entire dev environment spins up in milliseconds - even reinstalling `node_modules` is as simple as refreshing the page, with pnpm running up to four times as fast as locally!
- 📍 **It's just in your browser**: All development is happening directly in your browser. We're running Node.js, git, package managers (npm, yarn, pnpm), and local extensions all right from your browser. It's like local, but better.
- 🔒 **Secured by browser sandboxing**: Backed by the most battle tested and trusted environment in the world.
- 💻 **Works online and offline**: Continue your work even when you lose the Internet connection midway.
- 🔥 **Your environment is always online**: Your apps never go to sleep and have no bandwidth limits - share the URL with as many friends andcolleagues as you’d like!
- 🐞 **Seamless debugging**: With Chrome Dev Tools for both front- and backend apps!
- 🆓 **Always free for Open Source**: You're the future of the web development and we love you.

![Preview & debug](./assets/what-is-sb-intro.gif)

## What is StackBlitz used for?
## How can you use StackBlitz?

### Delightful docs

Expand All @@ -41,10 +42,6 @@ Create a [project starter](/guides/user-guide/starter-projects) or boilerplate c

Working on a blog post or a conference talk? [Create a StackBlitz project that you can quickly share](/guides/integration/embedding). You can change the project title and the slug to make it effortless for others to reach it. And yes, it works with Medium or DEV.

### Entire programming workflow

One click and our Codeflow IDE spins up a whole code editor with git integration and hot-reloading preview. Now all you need for your dev work is just a browser.

### Straightforward docs editing

Every project deserves collaborative documentation. Typo fixes have never been easier - click, see what you edit as you edit, and submit a PR when you’re satisfied. All in the browser, thanks to Web Publisher.
Expand All @@ -53,32 +50,28 @@ Every project deserves collaborative documentation. Typo fixes have never been e

Plain bug descriptions are so 2010s. Welcome to the new era of bug hunting where every report comes with its [own StackBlitz reproduction](/guides/integration/bug-reproductions) so you can instantly filter out true issues from everything else. Never spin up heavy local installations for a simple bug report ever again.

### Build whole educational experiences

You like the idea of running Node.js in the browser and feel inspired to build your own editor? No worries. Our [WebContainers API](/platform/api/webcontainer-api) allows you to use our technology to power your own playgrounds.

### Rapid prototyping

Speed up your entire development process with **realtime hot-reloading in the fastest dev environment ever made**. Collaborate remotely on different devices, send and receive instant feedback, and **get to market faster**.

### Entire programming workflow

## Components of StackBlitz
One click and our Next Gen IDE auto clones your repository, installs your dependencies and starts your dev server. It's an unparalelled workflow.

StackBlitz now helps you switch contexts seamlessly:
- <!--@include: ./parts/codeflow-ide.md-->
- <!--@include: ./parts/web-publisher.md-->
- <!--@include: ./parts/pr-new.md-->
- <!--@include: ./parts/codeflowapp-bot.md-->
### Build whole educational experiences

You like the idea of running Node.js in the browser and feel inspired to build your own editor? No worries. Our [WebContainers API](/platform/api/webcontainer-api) allows you to use our technology to power your own playgrounds.

## What about other online IDEs?

Unlike StackBlitz, legacy online IDEs run on remote servers and stream the results back to your browser. This approach yields **few security benefits** and **provides a worse experience** than your local machine in nearly every way.
Unlike StackBlitz, legacy online IDEs run on remote servers (or VMs) and stream the results back to your browser. This approach yields **few security benefits** and **provides a worse experience** than your local machine in nearly every way.

**StackBlitz solves these problems by doing all computing inside your browser**. This leverages decades of speed and security innovations and also **unlocks key development and debugging benefits**.

Lastly, StackBlitz is capable of running Node.js inside the browser so you can use the web to build the web.
StackBlitz runs Node.js in the browser so you can use the web to build the web.


<!-- @HeyGarrison: is this necessary? -->
## Get involved

We love our community! Please do stay in touch and:
Expand Down