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
4.**Explanation** – The [Learning](/learning) section.
59
+
1.**Tutorials** – The [Tutorials](https://developers.cloudflare.com/workers/tutorials) section.
60
+
2.**How-to guides** – Though a work-in-progress¹, [Examples](https://developers.cloudflare.com/workers/examples) and [Starters](https://developers.cloudflare.com/workers/starters).
4.**Explanation** – The [Learning](https://developers.cloudflare.com/workers/learning) section.
63
63
64
64
¹ _[Examples](/examples) certainly do “show how to solve a specific problem”, but as currently written, they don’t always provide a clear “series of steps”, similar to a recipe in a cookbook. This is something we’d like to improve over time._
65
65
@@ -81,7 +81,7 @@ Cloudflare documentation should be practical and approachable.
81
81
82
82
### Writing technical reference
83
83
84
-
When writing documentation as part of a technical reference (e.g. [runtime API](/runtime-apis) doc), follow these additional guidelines ([from Divio](https://documentation.divio.com/reference/#reference)):
84
+
When writing documentation as part of a technical reference (e.g. [runtime API](https://developers.cloudflare.com/workers/runtime-apis) doc), follow these additional guidelines ([from Divio](https://documentation.divio.com/reference/#reference)):
85
85
86
86
-**Structure the documentation around the codebase.** When documenting a set of APIs, for example, name and organize the files to match the codebase’s naming and folder structure. This helps ensure consistency when communicating with users, who may see and interact with codebase, and helps maintainers see where documentation is missing or needs to be updated.
Copy file name to clipboardExpand all lines: products/docs-engine/src/content/faq.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,14 +9,14 @@ order: 6
9
9
10
10
## Why a Docs Engine?
11
11
12
-
__tl:dr;__ You write good [Markdown (MDX)](/markdown), and the rest is taken care of.
12
+
__tl:dr;__ You write good [Markdown (MDX)](/reference/markdown), and the rest is taken care of.
13
13
14
14
__Details:__ Cloudflare has a large number of teams shipping product updates often. Most of these products have [their own documentation](https://developers.cloudflare.com/docs/). Over time we’ve found that it’s especially difficult to balance two important goals:
15
15
16
16
1. Content is easily managed by the product team that owns it.
17
17
2. Docs are consistent across products, providing the _best experience for our customers_, who commonly use more than one Cloudflare product together.
18
18
19
-
The Docs Engine strives to solve these problems by providing smart defaults with minimal [configuration](/site-configuration) and a wide variety of [composable MDX components](/markdown).
19
+
The Docs Engine strives to solve these problems by providing smart defaults with minimal [configuration](/reference/configuration) and a wide variety of [composable MDX components](/reference/markdown).
Copy file name to clipboardExpand all lines: products/docs-engine/src/content/how-it-works.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,7 +10,7 @@ __Note for Cloudflare employees:__ The details of this process are still being w
10
10
11
11
</Aside>
12
12
13
-
In short, docs sites built with the Cloudflare Docs Engine are [Gatsby](https://www.gatsbyjs.com) sites with a bunch of [custom MDX components](/markdown) and a shell UI you that’s consistent across products, all deployed as a [Workers Sites project](https://workers.cloudflare.com/sites) via the [Wrangler GitHub Action](https://github.com/cloudflare/wrangler-action).
13
+
In short, docs sites built with the Cloudflare Docs Engine are [Gatsby](https://www.gatsbyjs.com) sites with a bunch of [custom MDX components](/reference/markdown) and a shell UI you that’s consistent across products, all deployed as a [Workers Sites project](https://workers.cloudflare.com/sites) via the [Wrangler GitHub Action](https://github.com/cloudflare/wrangler-action).
Copy file name to clipboardExpand all lines: products/docs-engine/src/content/how-to-guides/migrate-a-product.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -93,10 +93,10 @@ At this point, you can make changes to the Markdown files inside the contect dir
93
93
94
94
In terms of improving/updating the content itself, there are a number of great resources available to help:
95
95
96
-
-__[Content framework](/contributing/content-framework)__ – Cloudflare’s new docs sites (e.g. [Workers](https://developers.cloudflare.com/workers/)) are starting to adhere to a content framework which may be helpful when thinking about how to structure your [pages](/reference/pages) (folders and Markdown files) and create logical [side navigation](/reference/sidebar).
96
+
-__[Content framework](/contributing/content-framework)__ – Cloudflare’s new docs sites (e.g. [Workers](https://developers.cloudflare.com/workers/)) are starting to adhere to a content framework which may be helpful when thinking about how to structure your [pages](/reference/pages) (folders and Markdown files) and create logical [side navigation](reference/pages#url-paths).
97
97
98
98
99
-
-__[Markdown (MDX) built-in components](/reference/markdown)__ – Migrating to the new Docs Engine means you can take advantage of all of its powerful [built-in components](/reference/markdown). Add an [aside](/reference/markdown), [display code beautifully](/reference/markdown/code-block-examples), [embed a video](/reference/markdown), add a buttons, definition list, and [so much more](/reference/markdown).
99
+
-__[Markdown (MDX) built-in components](/reference/markdown)__ – Migrating to the new Docs Engine means you can take advantage of all of its powerful [built-in components](/reference/markdown). Add an [aside](/reference/markdown#asides), [display code beautifully](reference/markdown#code-blocks), [embed a video](/reference/markdown#youtube), add a buttons, definition list, and [so much more](/reference/markdown).
100
100
101
101
102
102
-[__Workers docs site__ example](https://developers.cloudflare.com/workers) – You can also take a look at the [Workers content](https://github.com/cloudflare/cloudflare-docs/tree/4fd3a4af9507b20bb23fea4d7c4f4cd349c0f463/products/workers/src/content) for an example of a well-structured docs site.
Learn how [V8:Isolates power Workers](/how-workers-works#isolates).
26
+
Learn how to use [`<Asides/>`](/reference/markdown#asides).
27
27
```
28
28
29
29
-__Internal links__ will use [Gatsby’s `<Link/>` component](https://www.gatsbyjs.org/docs/gatsby-link/), which means they will be routed through `@reach/router` using `pushState`.
@@ -32,14 +32,14 @@ Learn how [V8:Isolates power Workers](/how-workers-works#isolates).
32
32
If you need to take advantage of Gatsby’s routing but you want control over the presentation of the link yourself, you can use `<Link/>` directly.
0 commit comments