You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+10-8Lines changed: 10 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,6 +8,10 @@ To report a bug, please go to https://support.stoplight.io/hc/en-us/requests/new
8
8
9
9
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.
10
10
11
+
## Documentation
12
+
13
+
To learn more about Studio and the Stoplight platform, see our [Platform Documentation](https://meta.stoplight.io/).
14
+
11
15
## Features
12
16
13
17
### 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
22
26
23
27

24
28
25
-
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).
29
+
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).
26
30
27
31
### JSON Schema Modeling
28
32
@@ -38,7 +42,7 @@ When it comes to API modeling, avoiding duplication of effort can be the differe
38
42
39
43
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.
40
44
41
-
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).
45
+
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).
42
46
43
47
### Technical Documentation
44
48
@@ -48,29 +52,27 @@ Mix API Reference Documentation and Markdown-based guides, how-tos, getting star
48
52
49
53
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.
50
54
51
-
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).
55
+
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).
52
56
53
57
### Style Guides and Validation
54
58
55
-
Enforce correctness and best practices with the native [Spectral](https://stoplight.io/spectral/) integration that alerts you to errors the moment they are created.
59
+
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.
56
60
57
61

58
62
59
63
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.
60
64
61
-
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).
62
-
63
65
### Built-in Mocking
64
66
65
67
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.
66
68
67
69

68
70
69
-
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).
71
+
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).
70
72
71
73
### Bring Your Own Repository
72
74
73
-
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!
75
+
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!
Copy file name to clipboardExpand all lines: docs/Basics/web-vs-desktop-app.md
+5-3Lines changed: 5 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,12 +4,14 @@ Stoplight Studio is available in two different formats: desktop and web. Studio
4
4
5
5
## Studio Web
6
6
7
-
The Studio Web interface is ideal for collaboration and working real time with existing hosted git repositories.
7
+
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.
8
8
9
-
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.
9
+
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.
10
+
11
+
Learn more about [Studio Web](https://meta.stoplight.io/docs/platform/ZG9jOjIwNjk2MQ-welcome-to-the-stoplight-docs).
10
12
11
13
## Studio Desktop
12
14
13
15
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.
14
16
15
-
This standalone tool can be used to edit the contents of any projects, whether they're linked to Stoplight Platform or not.
17
+
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.
0 commit comments