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

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

Open
wants to merge 33 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
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
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
name: "New Extension Request for Codeflow IDE \U0001F9E9"
about: Your favorite extension is missing from Codeflow IDE? Let us bring it over!
name: "New Extension Request for StackBlitz \U0001F9E9"
about: Your favorite extension is missing from StackBlitz? Let us bring it over!
title: 'EXTENSION REQUEST:'
labels: ''
assignees: sylwiavargas
assignees: HeyGarrison

---

Expand Down
4 changes: 2 additions & 2 deletions .vitepress/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ interface ThemeConfig extends DefaultTheme.Config {
};
}



export default defineConfigWithTheme<ThemeConfig>({
srcDir: './docs',
outDir: `./build${BASE_PATH}`,
Expand Down Expand Up @@ -88,15 +90,13 @@ export default defineConfigWithTheme<ThemeConfig>({
},
nav: [
{ text: 'Guides', link: defaultGroupLink('userGuide') },
{ text: 'Codeflow', link: defaultGroupLink('codeflow') },
{ text: 'API', link: defaultGroupLink('api') },
{ text: 'WebContainers', link: defaultGroupLink('webcontainers') },
{ text: 'Teams', link: defaultGroupLink('teams') },
{ text: 'Enterprise', link: defaultGroupLink('enterprise') },
],
sidebar: {
'/guides/': sidebarLinks('main', ['userGuide', 'integrationGuide']),
'/codeflow/': sidebarLinks('main', ['codeflow']),
'/teams/': sidebarLinks('main', ['teams']),
'/platform/api/': sidebarLinks('main', ['api']),
'/platform/webcontainers/': sidebarLinks('main', ['webcontainers']),
Expand Down
252 changes: 0 additions & 252 deletions .vitepress/config.ts.timestamp-1700579699301-7af714195b443.mjs

This file was deleted.

2 changes: 1 addition & 1 deletion .vitepress/theme/components/StarterGrid.vue
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ defineProps<{ links: any[] }>();
display: grid;
margin: 24px 0;
padding: 0;
grid-template-columns: repeat(auto-fit, minmax(280px, 1fr));
grid-template-columns: repeat(auto-fit, minmax(230px, 1fr));
gap: 16px;
list-style: none;
}
Expand Down
1 change: 0 additions & 1 deletion .vitepress/theme/data/types.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
export type MenuLinkGroup =
| 'api'
| 'codeflow'
| 'teams'
| 'enterprise'
| 'integrationGuide'
Expand Down
4 changes: 4 additions & 0 deletions .vitepress/theme/icons/fa-bolt.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ Except for small typo fixes and content updaets, the starting point for contribu
**If you don't have any specific issue you'd like to work on**, you can browse available ones. Please note that we use [issue labels](#issue-labels-we-use) so you can modify your search. After you've found an issue you'd like to work on, leave a comment and tell us when you have time to do that. A docs team member will assign you.

### 2. **Work on the issue**
Once assigned to an issue, choose [the right tool for the job](README.md#development) - you may want to use Web Publisher, Codeflow, or develop locally. We have no preference.
Once assigned to an issue, choose [the right tool for the job](README.md#development) - you may want to use Web Publisher, StackBlitz, or develop locally. We have no preference.

Whenever in doubt or whenever you feel stuck, please ask clarifying questions in the issue thread or on our [Discord](https://discord.gg/EQ7uJQxC). We are here to support you!

Expand Down
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ StackBlitz is an **instant fullstack web IDE for the JavaScript ecosystem**. It

Now you can use the web to build the web.

In fact, why not edit this docs in Codeflow IDE?
In fact, why not edit this docs in StackBlitz?

<a href="https://stackblitz.com/~/github.com/stackblitz/docs"><img style="display:inline" src="https://developer.stackblitz.com/img/open_in_codeflow.svg" alt="Open in Codeflow"></a>
<a href="https://stackblitz.com/~/github.com/stackblitz/docs"><img style="display:inline" src="https://developer.stackblitz.com/img/open_in_codeflow.svg" alt="Open in StackBlitz"></a>

---

Expand Down Expand Up @@ -65,7 +65,7 @@ If what you want to say doesn't really fall into actionable "problem" or "improv

There are three ways to interact with this repository:
- For **a small content update**, you can use [Web Publisher](#content-updates-with-web-publisher).
- If you want **to explore and develop** this site, use [StackBlitz Codeflow](#developing-with-stackblitz-codeflow).
- If you want **to explore and develop** this site, use [StackBlitz](#developing-with-stackblitz).
- Alternatively, you can [run the docs locally](#developing-locally).

### Content updates with Web Publisher
Expand All @@ -78,8 +78,8 @@ Use Web Publisher for small content updates for a pleasant editing experience:
4. You will be redirected to a GitHub PR template page prepared for you to submit a PR.


### Developing with StackBlitz Codeflow
Use StackBlitz Codeflow for bigger content updates. Codeflow will spin up the entire dev environment with a running dev server. When using Codeflow, please remember to commit and push your changes frequently.
### Developing with StackBlitz
Use StackBlitz for bigger content updates. StackBlitz will spin up the entire dev environment with a running dev server. When using StackBlitz, please remember to commit and push your changes frequently.

To access it, [click this button](https://stackblitz.com/~/github.com/stackblitz/docs).

Expand Down
Binary file removed docs/codeflow/assets/adding-dotenv-variables.gif
Binary file not shown.
Binary file removed docs/codeflow/assets/codeflowapp-issue.jpg
Binary file not shown.
Binary file removed docs/codeflow/assets/updating-variables-scope.gif
Binary file not shown.
Binary file removed docs/codeflow/assets/wp-editor-view.png
Binary file not shown.
Binary file removed docs/codeflow/assets/wp-open-in-ide.png
Binary file not shown.
Binary file removed docs/codeflow/assets/wp-opening-from-gh.gif
Binary file not shown.
Binary file removed docs/codeflow/assets/wp-preview-window-cut.png
Binary file not shown.
Binary file removed docs/codeflow/assets/wp-submitting-to-github.gif
Binary file not shown.
Binary file removed docs/codeflow/assets/wp-top-nav-bar-small-right.png
Binary file not shown.
Binary file removed docs/codeflow/assets/wp-top-nav-bar-small.png
Binary file not shown.
Binary file removed docs/codeflow/assets/wp-top-nav-bar-u.png
Binary file not shown.
100 changes: 0 additions & 100 deletions docs/codeflow/codeflow-faq.md

This file was deleted.

1 change: 0 additions & 1 deletion docs/codeflow/parts/codeflow-ide.md

This file was deleted.

3 changes: 0 additions & 3 deletions docs/codeflow/parts/installing-codeflowapp.md

This file was deleted.

1 change: 0 additions & 1 deletion docs/codeflow/parts/supported-packages.md

This file was deleted.

78 changes: 0 additions & 78 deletions docs/codeflow/what-is-codeflow.md

This file was deleted.

2 changes: 1 addition & 1 deletion docs/enterprise/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Unlock the full potential of your frontend development team with StackBlitz Ente

## Beta Features
- **WebContainers for Node.js Toolchains:** Full node.js dev server and terminal running locally in the browser
- **Codeflow:** Elevate your code editing capabilities with our in-browser VS Code based editor, with extension support
- **Next-generation editor:** Elevate your code editing capabilities with our in-browser VS Code based editor, with extension support
- **Enterprise Git Provider Integration:** Leverage your existing version control systems for even more streamlined workflows.

## Popular Use Cases
Expand Down
2 changes: 1 addition & 1 deletion docs/enterprise/starter-projects.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ This should create a temporary project (not yet saved to the database) using the
4. Edit the forked project's slug to: `polymer-base`.
5. Finally, go to `https://{your-instance}/admin/projects/polymer-base/edit` and change the value of the “Preset” field from `esm` to `polymer`, and save the project.

You should now have a project with the `polymer` preset and whose slug is `polymer-base`. Don't touch this project in the future (you can make it “frozen” in the [project settings](/guides/user-guide/ide-whats-on-your-screen#settings-sidebar) in the editor to prevent accidental changes) to make sure the SDK functionality works well.
You should now have a project with the `polymer` preset and whose slug is `polymer-base`. Don't touch this project in the future (you can make it “frozen” in the [project settings](/guides/user-guide/user-interface#settings-sidebar) in the editor to prevent accidental changes) to make sure the SDK functionality works well.

You can add this project to the list of starters on `https://{your-instance}/starters`.

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/guides/integration/assets/codeflowapp-pr.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/guides/integration/assets/embed-options.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/guides/integration/create-with-sdk.md
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ Now that you have the content of your project defined, it is useful to provide s

This is how the title and description look inside a StackBlitz project:

<img alt="Example of Title and Description displayed in StackBlitz editor" src="./assets/metadata.png" style="width:450px" />
<img alt="Example of Title and Description displayed in StackBlitz" src="./assets/metadata.png" style="width:450px" />

## Options: Customizing your project

Expand Down
12 changes: 6 additions & 6 deletions docs/guides/integration/embedding.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,22 @@
---
title: Embedding projects
description: Embedding is one way to display a StackBlitz editor in a documentation page, a blog post, or any other page. This page covers manual embedding in iframes.
title: Manually embedding projects
description: Embedding is one way to display StackBlitz in a documentation page, a blog post, or any other page. This page covers manual embedding in iframes.
og_image: embedding-projects.png
---

# {{ $frontmatter.title }}

Embedding is one way to display a StackBlitz editor in a documentation page, a blog post, or any other page. This page covers manual embedding in iframes. You can also do it [programmatically by using our SDK](/guides/integration/create-with-sdk).
Embedding is one way to display StackBlitz in a documentation page, a blog post, or any other page. This page covers manual embedding in iframes. You can also do it [programmatically by using our SDK](/guides/integration/create-with-sdk).

## Embedding StackBlitz project on a page

**1.** Open a project of your choosing and click the "Share" button in the top left navigation bar:

![Share Button in StackBlitz Editor](./assets/project-share-button.png)
![Share Button in StackBlitz](./assets/project-share-button.png)

**2.** In the popup window, choose the "Embed" tab. Customize your embed by choosing appropriate options from the panel on the right and check the preview on the bottom to see how your embed will look. If you're satisfied, copy the embed URL.

![Embed and Preview tabs in StackBlitz Editor](./assets/embed-project.png)
![Embed and Preview tabs in StackBlitz](./assets/embed-project.png)

:::tip
You can customize your embed further by adding suitable [query parameters](#embed-url-options).
Expand Down Expand Up @@ -69,5 +69,5 @@ You can use the following URL query parameters to customize the appearance and f
Alternatively, you can use our [JavaScript SDK methods](/platform/api/javascript-sdk) for embedding StackBlitz projects in pages to avoid creating and configuring iframes.


[ui_docs]: /guides/user-guide/ide-whats-on-your-screen
[ui_docs]: /guides/user-guide/user-interface
[available_env_docs]: /guides/user-guide/available-environments
Loading