Skip to content

Commit

Permalink
Docs fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
SergkeiM committed Aug 21, 2024
1 parent 0dab077 commit 1ae8e17
Show file tree
Hide file tree
Showing 33 changed files with 52 additions and 42 deletions.
6 changes: 3 additions & 3 deletions docs/app.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,12 @@ export default defineAppConfig({
},
aside: {
level: 1,
collapsed: true,
collapsed: false,
},
header: {
logo: {
dark: '/logo-new.png',
light: '/logo-new.png',
dark: '/logo-light.png',
light: '/logo-dark.png',
},
},
footer: {
Expand Down
2 changes: 1 addition & 1 deletion docs/content/2.api/0.accounts/0.accounts.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: An account refers to an organization account. Accounts contain one

An account refers to an organization account. Accounts contain one or more users and can contain one or more zones. A user can be part of one or more accounts.

:button-link[Cloudflare API docs]{href="https://developers.cloudflare.com/api/operations/accounts-list-accounts" blank}
:button-link[Cloudflare API docs]{icon="heroicons-outline:external-link" href="https://developers.cloudflare.com/api/operations/accounts-list-accounts" blank}

## List

Expand Down
2 changes: 1 addition & 1 deletion docs/content/2.api/0.accounts/1.roles.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: Whenever you add a new member to your account, you can assign polic

Whenever you add a new member to your account, you can assign policies to those users and make use of the available roles. Roles can only ever be assigned to their given scope and multiple roles can be assigned to a given policy.

:button-link[Cloudflare API docs]{href="https://developers.cloudflare.com/api/operations/account-roles-list-roles" blank}
:button-link[Cloudflare API docs]{icon="heroicons-outline:external-link" href="https://developers.cloudflare.com/api/operations/account-roles-list-roles" blank}

## List

Expand Down
2 changes: 1 addition & 1 deletion docs/content/2.api/0.accounts/2.members.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: On any Cloudflare account, you can collaborate by adding members to

On any Cloudflare account, you can collaborate by adding members to your account and assigning them access via one or several policies.

:button-link[Cloudflare API docs]{href="https://developers.cloudflare.com/api/operations/account-members-list-members" blank}
:button-link[Cloudflare API docs]{icon="heroicons-outline:external-link" href="https://developers.cloudflare.com/api/operations/account-members-list-members" blank}

## List

Expand Down
2 changes: 1 addition & 1 deletion docs/content/2.api/0.accounts/4,audit-logs.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: Audit logs summarize the history of changes made within your Cloudf

Audit logs summarize the history of changes made within your Cloudflare account. Audit logs include account level actions like login, as well as zone configuration changes.

:button-link[Cloudflare API docs]{href="https://developers.cloudflare.com/api/operations/audit-logs-get-account-audit-logs" blank}
:button-link[Cloudflare API docs]{icon="heroicons-outline:external-link" href="https://developers.cloudflare.com/api/operations/audit-logs-get-account-audit-logs" blank}

## Get

Expand Down
4 changes: 2 additions & 2 deletions docs/content/2.api/1.zones/0.index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@ title: Zones
description: Domains (or subdomains) that are added to Cloudflare become zones, which have a direct impact on the security and performance of your website, application, or API
---

# Zones
# Zones [:icon{name="heroicons-outline:external-link"}](https://developers.cloudflare.com/api/operations/zones-get)

Domains (or subdomains) that are added to Cloudflare become zones, which have a direct impact on the security and performance of your website, application, or API. Use your zone to monitor security and performance, update configurations, and apply zone-level products and services.

:button-link[Cloudflare API docs]{href="https://developers.cloudflare.com/api/operations/zones-get" blank}
:button-link[Cloudflare API docs]{icon="heroicons-outline:external-link" href="https://developers.cloudflare.com/api/operations/zones-get" blank}

## List

Expand Down
2 changes: 1 addition & 1 deletion docs/content/2.api/1.zones/1.dns.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: View, create, update your zones DNS Records on Cloudflare.

View, create, update your zones DNS Records on Cloudflare.

:button-link[Cloudflare API docs]{href="https://developers.cloudflare.com/api/operations/dns-records-for-a-zone-list-dns-records" blank}
:button-link[Cloudflare API docs]{icon="heroicons-outline:external-link" href="https://developers.cloudflare.com/api/operations/dns-records-for-a-zone-list-dns-records" blank}

## Scan

Expand Down
2 changes: 1 addition & 1 deletion docs/content/2.api/1.zones/2.dnssec.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: DNS Security Extensions (DNSSEC) adds an extra layer of authenticat

DNS Security Extensions (DNSSEC) adds an extra layer of authentication to DNS, ensuring requests are not routed to a spoofed domain.

:button-link[Cloudflare API docs]{href="https://developers.cloudflare.com/api/operations/dnssec-dnssec-details" blank}
:button-link[Cloudflare API docs]{icon="heroicons-outline:external-link" href="https://developers.cloudflare.com/api/operations/dnssec-dnssec-details" blank}

## Details

Expand Down
2 changes: 1 addition & 1 deletion docs/content/2.api/1.zones/2.page-rules.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: Cloudflare Page Rules allow you to make adjustments to requests, co

Cloudflare Page Rules allow you to make adjustments to requests, configure Cloudflare settings, and trigger specific actions for matching requests.

:button-link[Cloudflare API docs]{href="https://developers.cloudflare.com/api/operations/page-rules-list-page-rules" blank}
:button-link[Cloudflare API docs]{icon="heroicons-outline:external-link" href="https://developers.cloudflare.com/api/operations/page-rules-list-page-rules" blank}

## Settings

Expand Down
2 changes: 1 addition & 1 deletion docs/content/2.api/1.zones/4.cloud-conenctor-rules.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: Cloud Connector allows you to route matching incoming traffic from

Cloud Connector allows you to route matching incoming traffic from your website to a public cloud provider that you define such as AWS, Google Cloud, and Azure. With Cloud Connector you can make Cloudflare the control center for your web traffic, including traffic served from public cloud providers, without having to configure additional rules.

:button-link[Cloudflare API docs]{href="https://developers.cloudflare.com/api/operations/zone-cloud-connector-rules" blank}
:button-link[Cloudflare API docs]{icon="heroicons-outline:external-link" href="https://developers.cloudflare.com/api/operations/zone-cloud-connector-rules" blank}

## Get

Expand Down
2 changes: 1 addition & 1 deletion docs/content/2.api/1.zones/5.holds.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ navigation:

Zone holds prevent other teams in your organization from adding zones that are already active in another account.

:button-link[Cloudflare API docs]{href="https://developers.cloudflare.com/api/operations/zones-0-hold-get" blank}
:button-link[Cloudflare API docs]{icon="heroicons-outline:external-link" href="https://developers.cloudflare.com/api/operations/zones-0-hold-get" blank}

## Get

Expand Down
2 changes: 1 addition & 1 deletion docs/content/2.api/1.zones/6.lockdown.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ navigation:

Zone Lockdown specifies a list of one or more IP addresses, CIDR ranges, or networks that are the only IPs allowed to access a domain, subdomain, or URL. You can configure multiple destinations, including IPv4/IPv6 addresses, in a single Zone Lockdown rule.

:button-link[Cloudflare docs]{href="https://developers.cloudflare.com/api/operations/zone-lockdown-list-zone-lockdown-rules" blank}
:button-link[Cloudflare API docs]{icon="heroicons-outline:external-link" href="https://developers.cloudflare.com/api/operations/zone-lockdown-list-zone-lockdown-rules" blank}

## List

Expand Down
2 changes: 1 addition & 1 deletion docs/content/2.api/2.workers/0.analytics.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ navigation:

Retrieves Workers KV metrics for the given account.

:button-link[Cloudflare docs]{href="https://developers.cloudflare.com/api/operations/workers-kv-request-analytics-query-request-analytics" blank}
:button-link[Cloudflare API docs]{icon="heroicons-outline:external-link" href="https://developers.cloudflare.com/api/operations/workers-kv-request-analytics-query-request-analytics" blank}

## Request Analytics

Expand Down
2 changes: 1 addition & 1 deletion docs/content/2.api/2.workers/1.settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ navigation:

# Account settings

:button-link[Cloudflare docs]{href="https://developers.cloudflare.com/api/operations/worker-account-settings-fetch-worker-account-settings" blank}
:button-link[Cloudflare API docs]{icon="heroicons-outline:external-link" href="https://developers.cloudflare.com/api/operations/worker-account-settings-fetch-worker-account-settings" blank}

## Fetch

Expand Down
2 changes: 1 addition & 1 deletion docs/content/2.api/2.workers/10.logs.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ navigation:

# Tail Logs

:button-link[Cloudflare docs]{href="https://developers.cloudflare.com/api/operations/worker-tail-logs-list-tails" blank}
:button-link[Cloudflare API docs]{icon="heroicons-outline:external-link" href="https://developers.cloudflare.com/api/operations/worker-tail-logs-list-tails" blank}

## List Tails

Expand Down
2 changes: 1 addition & 1 deletion docs/content/2.api/2.workers/11.routes.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ navigation:

# Routes

:button-link[Cloudflare docs]{href="https://developers.cloudflare.com/api/operations/worker-routes-list-routes" blank}
:button-link[Cloudflare API docs]{icon="heroicons-outline:external-link" href="https://developers.cloudflare.com/api/operations/worker-routes-list-routes" blank}

## List

Expand Down
2 changes: 1 addition & 1 deletion docs/content/2.api/2.workers/2.cron.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ navigation:

Cron Triggers allow users to map a cron expression to a Worker using a scheduled() handler that enables Workers to be executed on a schedule.

:button-link[Cloudflare docs]{href="https://developers.cloudflare.com/api/operations/worker-cron-trigger-get-cron-triggers" blank}
:button-link[Cloudflare API docs]{icon="heroicons-outline:external-link" href="https://developers.cloudflare.com/api/operations/worker-cron-trigger-get-cron-triggers" blank}

## Fetch

Expand Down
2 changes: 1 addition & 1 deletion docs/content/2.api/2.workers/3.deployments.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ navigation:

Deployments track the version(s) of your Worker that are actively serving traffic. A deployment can consist of one or two versions of a Worker.

:button-link[Cloudflare docs]{href="https://developers.cloudflare.com/api/operations/worker-deployments-list-deployments" blank}
:button-link[Cloudflare API docs]{icon="heroicons-outline:external-link" href="https://developers.cloudflare.com/api/operations/worker-deployments-list-deployments" blank}

## List

Expand Down
2 changes: 1 addition & 1 deletion docs/content/2.api/2.workers/4.domains.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ navigation:

# Domains

:button-link[Cloudflare docs]{href="https://developers.cloudflare.com/api/operations/worker-domain-list-domains" blank}
:button-link[Cloudflare API docs]{icon="heroicons-outline:external-link" href="https://developers.cloudflare.com/api/operations/worker-domain-list-domains" blank}

## List

Expand Down
2 changes: 1 addition & 1 deletion docs/content/2.api/2.workers/5.environment.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ navigation:

Wrangler allows you to deploy the same Worker application with different configuration for each environment. You must configure environments in your Worker application’s wrangler.toml file.

:button-link[Cloudflare docs]{href="https://developers.cloudflare.com/api/operations/worker-environment-get-script-content" blank}
:button-link[Cloudflare API docs]{icon="heroicons-outline:external-link" href="https://developers.cloudflare.com/api/operations/worker-environment-get-script-content" blank}

## Get script content

Expand Down
2 changes: 1 addition & 1 deletion docs/content/2.api/2.workers/6.scripts.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ navigation:

# Scripts

:button-link[Cloudflare docs]{href="https://developers.cloudflare.com/api/operations/worker-script-list-workers" blank}
:button-link[Cloudflare API docs]{icon="heroicons-outline:external-link" href="https://developers.cloudflare.com/api/operations/worker-script-list-workers" blank}

## List Workers

Expand Down
2 changes: 1 addition & 1 deletion docs/content/2.api/2.workers/7.subdomain.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ navigation:

# Subdomain

:button-link[Cloudflare docs]{href="https://developers.cloudflare.com/api/operations/worker-subdomain-get-subdomain" blank}
:button-link[Cloudflare API docs]{icon="heroicons-outline:external-link" href="https://developers.cloudflare.com/api/operations/worker-subdomain-get-subdomain" blank}

## Get Subdomain

Expand Down
2 changes: 1 addition & 1 deletion docs/content/2.api/2.workers/8.versions.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ navigation:

You can upload changes (versions) to your Worker independent of changing the version that is actively serving traffic (deployment).

:button-link[Cloudflare docs]{href="https://developers.cloudflare.com/api/operations/worker-versions-list-versions" blank}
:button-link[Cloudflare API docs]{icon="heroicons-outline:external-link" href="https://developers.cloudflare.com/api/operations/worker-versions-list-versions" blank}

## List Versions

Expand Down
2 changes: 1 addition & 1 deletion docs/content/2.api/2.workers/9.kv.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ navigation:

# KV

:button-link[Cloudflare docs]{href="https://developers.cloudflare.com/api/operations/workers-kv-namespace-list-namespaces" blank}
:button-link[Cloudflare API docs]{icon="heroicons-outline:external-link" href="https://developers.cloudflare.com/api/operations/workers-kv-namespace-list-namespaces" blank}

## List Namespaces

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,14 @@
title: Cloudflare D1
description: Cloudflare D1
navigation:
title: Cloudflare D1
title: D1
---

# Cloudflare D1

D1 is Cloudflare’s native serverless database. D1 allows you to build applications that handle large amounts of users at no extra cost. With D1, you can restore your database to any minute within the last 30 days.

:button-link[Cloudflare API docs]{href="https://developers.cloudflare.com/api/operations/cloudflare-d1-list-databases" blank}
:button-link[Cloudflare API docs]{icon="heroicons-outline:external-link" href="https://developers.cloudflare.com/api/operations/cloudflare-d1-list-databases" blank}

## List

Expand Down
10 changes: 10 additions & 0 deletions docs/content/2.api/3.d1/query-builder.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: D1 Query Builder
description: D1 Query Builder
navigation:
title: Query Builder
---

# D1 Query Builder

// TODO
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ navigation:

# Routing

:button-link[Cloudflare docs]{href="https://developers.cloudflare.com/api/operations/tunnel-route-list-tunnel-routes" blank}
:button-link[Cloudflare API docs]{icon="heroicons-outline:external-link" href="https://developers.cloudflare.com/api/operations/tunnel-route-list-tunnel-routes" blank}

## List

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ navigation:

# Virtual Networks

:button-link[Cloudflare docs]{href="https://developers.cloudflare.com/api/operations/tunnel-virtual-network-list-virtual-networks" blank}
:button-link[Cloudflare API docs]{icon="heroicons-outline:external-link" href="https://developers.cloudflare.com/api/operations/tunnel-virtual-network-list-virtual-networks" blank}

## List

Expand Down
2 changes: 1 addition & 1 deletion docs/content/2.api/5.ips.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ navigation:

Get IPs used on the Cloudflare/JD Cloud network, see https://www.cloudflare.com/ips for Cloudflare IPs or https://developers.cloudflare.com/china-network/reference/infrastructure/ for JD Cloud IPs.

:button-link[Cloudflare docs]{href="https://developers.cloudflare.com/api/operations/cloudflare-i-ps-cloudflare-ip-details" blank}
:button-link[Cloudflare API docs]{icon="heroicons-outline:external-link" href="https://developers.cloudflare.com/api/operations/cloudflare-i-ps-cloudflare-ip-details" blank}

```php [php]
$response = $client->ips()->get();
Expand Down
Binary file added docs/public/logo-dark.png
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/public/logo-light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/public/logo-new.png
Binary file not shown.
20 changes: 10 additions & 10 deletions docs/tokens.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,16 @@ import { defineTheme } from 'pinceau'
export default defineTheme({
color: {
primary: {
50: { value: '#fdf3e2' },
100: { value: '#fdf1e7' },
200: { value: '#fbdbc1' },
300: { value: '#f8c296' },
400: { value: '#f4a15d' },
500: { value: '#e06d10' },
600: { value: '#b6590d' },
700: { value: '#a24f0b' },
800: { value: '#5b2c06' },
900: { value: '#341a04' },
50: { value: '#fffcf9' },
100: { value: '#fef8f3' },
200: { value: '#fef1e7' },
300: { value: '#fde3ce' },
400: { value: '#fac59a' },
500: { value: '#f79e57' },
600: { value: '#f48123' },
700: { value: '#d36e1c' },
800: { value: '#be6319' },
900: { value: '#a75716' },
},
},
})

0 comments on commit 1ae8e17

Please sign in to comment.