Skip to content
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
169 changes: 0 additions & 169 deletions CONTRIBUTING.md

This file was deleted.

61 changes: 7 additions & 54 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,45 +1,14 @@
# Cloudflare Docs
# Cloudflare Developer Documentation

**[View the docs →](https://developers.cloudflare.com/)**
Welcome to the open-source repository for all [Cloudflare Developer Documentation](https://developers.cloudflare.com/).

## Why Cloudflare Docs is open source
Everyone, including those who are not part of the Cloudflare organization, are encouraged to contribute.
- If you are not a Cloudflare employee, learn how to contribute in the [contribution page](https://developers.cloudflare.com/style-guide/contributions/) of the Cloudflare Style Guide.
- If you are a Cloudflare employee, reach out via our Developer Docs space in Google chat.

Our documentation is open source so that we can stay connected with our community and quickly implement feedback. Whether you have opened an issue to provide feedback or contributed your own content, we thank you for helping us maintain quality documentation.
Consult the [Cloudflare Style Guide](https://developers.cloudflare.com/style-guide/) on everything from grammar, to formatting, to frontmatter requirements. Browse our [components](/style-guide/components/) to add additional formatting such as [notes](/style-guide/documentation-content-strategy/component-attributes/notes-tips-warnings/) and [code blocks](/style-guide/components/code/).

If you have any feedback for our documentation or are interested in contributing, please refer to our [contribution guidelines.](https://github.com/cloudflare/cloudflare-docs/blob/production/CONTRIBUTING.md)

## Setup

You must have a recent version of Node.js (22+) installed. You may use [Volta](https://github.com/volta-cli/volta), a Node version manager, to install the latest version of Node and `npm`, which is a package manager that is included with `node`'s installation.

```sh
$ curl https://get.volta.sh | bash
$ volta install node@22
```

Install the Node.js dependencies for this project using npm or another package manager:

```sh
$ npm install
```

## Development

When making changes to the site, including any content changes, you may run a local development server by running the following command:

```sh
$ npm run dev
```

This spawns a server that will be accessible via `http://localhost:1111` in your browser. Additionally, any changes made within the project – including `content/**` changes – will automatically reload your browser tab(s), allowing you to instantly preview your changes.

## Deployment

Our docs are deployed using [Cloudflare Pages](https://pages.cloudflare.com). Every commit pushed to production will automatically deploy to [developers.cloudflare.com](https://developers.cloudflare.com), and any pull requests opened will have a corresponding staging URL available in the pull request comments.

## For Cloudflare employees

To get write access to this repo, please reach out to the **Developer Docs** room in chat.
Thank you for helping us to maintain quality documentation.

## License and Legal Notices

Expand All @@ -49,19 +18,3 @@ Cloudflare products and services referenced in the documentation may be either t
Cloudflare and any contributors reserve all other rights, whether under their respective copyrights, patents, or trademarks, whether by implication, estoppel, or otherwise.

Please note that we may use AI tools to help us review technical documentation, pull requests and other issues submitted to our public GitHub page in order to identify and correct mistakes and other inconsistencies in our developer documentation. Please refrain from sharing any personal information in your submissions.


## 🧞 Commands

All commands are run from the root of the project, from a terminal:

| Command | Action |
|:--------------------------|:--------------------------------------------|
| `npm install` | Installs dependencies |
| `npm run dev` | Starts local dev server at `localhost:1111` |
| `npx astro build` | Build your production site to `./dist/` |
| `npm run astro -- --help` | Get help using the Astro CLI |

## 👀 Want to learn more?

Check out [Starlight’s docs](https://starlight.astro.build/), read [the Astro documentation](https://docs.astro.build), or jump into the [Astro Discord server](https://astro.build/chat).
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ head: []
description: Consider information about post-quantum cryptography at Cloudflare - deployed key agreements and software support.
---

Cloudflare's deployment of post-quantum [hybrid key agreements](/ssl/post-quantum-cryptography/#hybrid-key-agreement) is supported by different software as listed below. [Contributions](https://github.com/cloudflare/cloudflare-docs/blob/production/CONTRIBUTING.md) to keep the listing up-to-date are welcome!
Cloudflare's deployment of post-quantum [hybrid key agreements](/ssl/post-quantum-cryptography/#hybrid-key-agreement) is supported by different software as listed below. [Contributions](/style-guide/contributions/) to keep the listing up-to-date are welcome.

:::caution
The list below is for reference only. Responsibility for third-party software lies with their respective maintainers. Use them at your own discretion.
Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/style-guide/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Understanding Cloudflare style is the first step in being able to write, review,
- Minimized customer confusion
- Simplified translation process

Visit the [Cloudflare Docs](https://github.com/cloudflare/cloudflare-docs) repository to contribute to developer documentation.
To contribute to the documentation, visit the [contributor guide](/style-guide/contributions/).

## Available resources

Expand Down
4 changes: 1 addition & 3 deletions src/content/docs/turnstile/community-resources.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,7 @@ As such, Cloudflare is not liable for any damages arising from using them.

:::note

Did we miss your library? [Contribute to our list][1].

[1]: https://github.com/cloudflare/cloudflare-docs/blob/production/CONTRIBUTING.md#pull-request-guidelines
Did we miss your library? [Contribute to our list](/style-guide/contributions/)

:::

Expand Down
2 changes: 1 addition & 1 deletion src/plugins/expressive-code/graphql-api-explorer.js
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ async function compressGql(gql) {
}

/**
* See CONTRIBUTING.md for instructions on how to use this plugin.
* See https://developers.cloudflare.com/style-guide/contributions/ for instructions on how to use this plugin.
* @param {string} query
*/
function autoPopulateGraphQLVariables(query) {
Expand Down
Loading