Pam 294 migration to platform phase 2 (#591)

* Removed studio version of working with files * Removed project config * Removed doc getting started * Removed doc quick start * Modified 2 files * Deleted docs/01-getting-started.md * migrated ui overview to platform * Modified docs/Basics/web-vs-desktop-app.md * Modified README.md
stoplightio · Apr 1, 2022 · 54ff331 · 54ff331
1 parent 4902d76
commit 54ff331
Show file tree

Hide file tree

Showing 10 changed files with 15 additions and 383 deletions.
diff --git a/README.md b/README.md
@@ -8,6 +8,10 @@ To report a bug, please go to https://support.stoplight.io/hc/en-us/requests/new
 
 Studio is Stoplight's next generation application for API design, modeling, and technical writing. A primary goal of Studio is to enrich, not replace, your existing workflows. When running locally it works fully offline, with folders and files on your computer just like your favorite IDE. When running in the browser, the web-native Git support allows you to effortlessly work with your existing repositories safely and efficiently.
 
+## Documentation
+
+To learn more about Studio and the Stoplight platform, see our [Platform Documentation](https://meta.stoplight.io/).
+
 ## Features
 
 ### Full Support for OpenAPI v2 and v3
@@ -22,7 +26,7 @@ Form-based designing means you don't need to be an OpenAPI expert to get started
 
 ![Graphical Design for OpenAPI](assets/images/form-editor.png)
 
-To find out more about how you can quickly design and prototype APIs without writing a single line of JSON or YAML, see [here](./docs/Design-and-Modeling/01-getting-started.md).
+To find out more about how you can quickly design and prototype APIs without writing a single line of JSON or YAML, see [here](https://meta.stoplight.io/docs/platform/ZG9jOjM2OTM3Mjg5-overview).
 
 ### JSON Schema Modeling
 
@@ -38,7 +42,7 @@ When it comes to API modeling, avoiding duplication of effort can be the differe
 
 Studio allows you to quickly and easily find and reuse the objects you need, as you need them. No more recreating models for different endpoints, no more having to update dozens of different endpoints because a new field was added.
 
-To find out more about how you can leverage references to scale your API consistency, see [here](https://meta.stoplight.io/docs/platform/branches/pam-215-doc-overview-updates/ZG9jOjM2OTM3Mjk0-use-references).
+To find out more about how you can leverage references to scale your API consistency, see [here](https://meta.stoplight.io/docs/platform/ZG9jOjIyNTY5MzIw-shared-components).
 
 ### Technical Documentation
 
@@ -48,29 +52,27 @@ Mix API Reference Documentation and Markdown-based guides, how-tos, getting star
 
 You can even host the files in your own Git repository, and then publish when you're ready to show off your latest and greatest.
 
-To find out more about writing technical documentation in Studio, see our getting started guide [here](https://stoplight.io/p/docs/gh/stoplightio/studio/docs/Documentation/01-getting-started.md).
+To find out more about writing technical documentation in Studio, see our getting started guide [here](https://meta.stoplight.io/docs/platform/ZG9jOjQ2OTE4Njk3-documentation-quick-start).
 
 ### Style Guides and Validation
 
-Enforce correctness and best practices with the native [Spectral](https://stoplight.io/spectral/) integration that alerts you to errors the moment they are created.
+Enforce correctness and best practices with [Style Guides](https://meta.stoplight.io/docs/platform/ZG9jOjMwMDI3MjA2-style-guide-overview), powered by the native [Spectral](https://stoplight.io/spectral/) integration that alerts you to errors the moment they are created.
 
 ![Spectral validates and lints your APIs to ensure they are correct and functional](assets/images/spectral1.png)
 
 Clicking on errors or warnings also brings you to exactly where they are located in the document, making it easy to fix errors at the source.
 
-To find out more about Spectral and how validations can improve your API design workflow, see [here](https://meta.stoplight.io/docs/platform/branches/pam-215-doc-overview-updates/ZG9jOjMwMDI3MjA2-overview).
-
 ### Built-in Mocking
 
 When running locally, Studio will automatically start a local [Prism mock server](https://stoplight.io/prism/) for every API defined in your project, and keep that mock server up to date as you change your designs.
 
 ![Mocking allows you to quickly test the look and feel of your API before jumping into the code](assets/images/studio-mocking.png)
 
-To find out more about Prism and how mocking can be used to streamline your API development process, see [here](https://meta.stoplight.io/docs/platform/branches/pam-215-doc-overview-updates/ZG9jOjM2OTM3Mjg4-work-with-mock-servers).
+To find out more about Prism and how mocking can be used to streamline your API development process, see [here](https://meta.stoplight.io/docs/platform/ZG9jOjM2OTM3Mjg4-work-with-mock-servers).
 
 ### Bring Your Own Repository
 
-Since Studio works with your local filesystem, you can open up your API projects and start adding docs and designs alongside the actual implementation they are meant to describe. Once you're done, check it all into Git with your favorite Git client!
+Since Studio works with your local file system, you can open up your API projects and start adding docs and designs alongside the actual implementation they are meant to describe. Once you're done, check it all into Git with your favorite Git client!
 
 ## License
 

diff --git a/assets/images/create-api-with-config.gif b/assets/images/create-api-with-config.gif
diff --git a/docs/01-getting-started.md b/docs/01-getting-started.md
diff --git a/docs/Basics/01-working-with-projects.md b/docs/Basics/01-working-with-projects.md
diff --git a/docs/Basics/02-working-with-files.md b/docs/Basics/02-working-with-files.md
diff --git a/docs/Basics/03-stoplight-config.md b/docs/Basics/03-stoplight-config.md
diff --git a/docs/Basics/ui-overview.md b/docs/Basics/ui-overview.md
diff --git a/docs/Basics/web-vs-desktop-app.md b/docs/Basics/web-vs-desktop-app.md
@@ -4,12 +4,14 @@ Stoplight Studio is available in two different formats: desktop and web. Studio
 
 ## Studio Web
 
-The Studio Web interface is ideal for collaboration and working real time with existing hosted git repositories. 
+The Studio Web interface is ideal for collaboration and working real time with existing hosted Git repositories. For quick and easy publishing, you can also create projects that are not tied to a repository.
 
-In the past it was a standalone tool, but it is now part of the larger [Stoplight Platform](https://stoplight.io/welcome) ecosystem, which provides hosted documentation, an Explorer for searching across multiple APIs, a design library, and all sorts of other powerful stuff.
+In the past it was a standalone tool, but it is now part of the larger [Stoplight Platform](https://stoplight.io/welcome) ecosystem, which provides API design and style guide editors, hosted documentation, an Explorer for searching across multiple APIs, and much more.
+
+Learn more about [Studio Web](https://meta.stoplight.io/docs/platform/ZG9jOjIwNjk2MQ-welcome-to-the-stoplight-docs).
 
 ## Studio Desktop
 
 The [Studio Desktop](https://stoplight.io/studio/) application provides an offline-first, native interface for designing and modeling your APIs. It also allows you to work directly with local files and folders on your computer.
 
-This standalone tool can be used to edit the contents of any projects, whether they're linked to Stoplight Platform or not. 
+This standalone tool can be used to edit the contents of any projects, whether they're linked to Stoplight Platform or not. See [Local Projects](https://meta.stoplight.io/docs/platform/ZG9jOjQ1NTQxMw-publish-with-the-stoplight-cli) for details.