Skip to content

Commit 302d8f1

Browse files
committed
fix docs-engine links
1 parent 90fe0a6 commit 302d8f1

File tree

6 files changed

+17
-17
lines changed

6 files changed

+17
-17
lines changed

products/docs-engine/src/content/contributing/content-framework.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -56,10 +56,10 @@ The first Cloudflare product to adopt this system was the Cloudflare Workers doc
5656

5757
Within Cloudflare Workers, the division is as as follows:
5858

59-
1. **Tutorials** – The [Tutorials](/tutorials) section.
60-
2. **How-to guides** – Though a work-in-progress¹, [Examples](/examples) and [Starters](/starters).
61-
3. **Technical reference** – Three² components: [Platform](/platform), [Runtime APIs](/runtime-apis), and [CLI (Wrangler)](/cli-wrangler).
62-
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).
61+
3. **Technical reference** – Three² components: [Platform](https://developers.cloudflare.com/workers/platform), [Runtime APIs](https://developers.cloudflare.com/workers/runtime-apis), and [CLI (Wrangler)](https://developers.cloudflare.com/workers/cli-wrangler).
62+
4. **Explanation** – The [Learning](https://developers.cloudflare.com/workers/learning) section.
6363

6464
¹ _[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._
6565

@@ -81,7 +81,7 @@ Cloudflare documentation should be practical and approachable.
8181

8282
### Writing technical reference
8383

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)):
8585

8686
- **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.
8787

products/docs-engine/src/content/faq.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,14 @@ order: 6
99

1010
## Why a Docs Engine?
1111

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.
1313

1414
__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:
1515

1616
1. Content is easily managed by the product team that owns it.
1717
2. Docs are consistent across products, providing the _best experience for our customers_, who commonly use more than one Cloudflare product together.
1818

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).
2020

2121
## How does the main navigation work?
2222

products/docs-engine/src/content/how-it-works.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ __Note for Cloudflare employees:__ The details of this process are still being w
1010

1111
</Aside>
1212

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).
1414

1515
--------------------------------
1616

products/docs-engine/src/content/how-to-guides/migrate-a-product.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -93,10 +93,10 @@ At this point, you can make changes to the Markdown files inside the contect dir
9393

9494
In terms of improving/updating the content itself, there are a number of great resources available to help:
9595

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).
9797

9898

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).
100100

101101

102102
- [__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.

products/docs-engine/src/content/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ order: 0
1010

1111
Documentation for the __Docs Engine__ which powers Cloudflare’s developer docs.
1212

13-
The engine is built with [Gatsby](https://www.gatsbyjs.com/), and makes generous use of custom [MDX components](/markdown).
13+
The engine is built with [Gatsby](https://www.gatsbyjs.com/), and makes generous use of custom [MDX components](/reference/markdown).
1414

1515
It’s __open-source__ and [available on GitHub](https://github.com/cloudflare/cloudflare-docs-engine).
1616

products/docs-engine/src/content/reference/markdown.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,9 @@ Visit [example.com](https://example.com).
2121
```markdown
2222
Visit [example.com](https://example.com).
2323

24-
View the [Tutorials](/tutorials) tutorials.
24+
View the [How it Works](/how-it-works) page.
2525

26-
Learn how [V8:Isolates power Workers](/how-workers-works#isolates).
26+
Learn how to use [`<Asides/>`](/reference/markdown#asides).
2727
```
2828

2929
- __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).
3232
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.
3333

3434
```markdown
35-
<Link to="/examples" className="Button Button-is-secondary">
36-
View examples
35+
<Link to="/how-it-works" className="Button Button-is-secondary">
36+
How it Works
3737
</Link>
3838
```
3939

4040
<Example>
41-
<Link to="/examples" className="Button Button-is-secondary">
42-
View examples
41+
<Link to="/how-it-works" className="Button Button-is-secondary">
42+
How it Works
4343
</Link>
4444
</Example>
4545

0 commit comments

Comments
 (0)