# Astro Docs <img align="right" valign="center" height="52" width="39" src="https://raw.githubusercontent.com/withastro/astro/main/assets/brand/logo.svg" alt="Astro logo" />

To all who come to this happy place: welcome.

This is the repo for [docs.astro.build](https://docs.astro.build/).
This repo contains all the source code we use to build our docs site.

## We are Astro

Astro is a site builder for the web platform.
We want everyone to be successful building sites, and that means helping everyone understand how Astro works.

## You are Awesome

You can also help make the docs awesome.
Your feedback is welcome.
Your writing, editing, translating, designing, and developing skills are welcome.
You being a part of our community is welcome.

## Chat with Us

You can learn more about Astro, get support, and meet other devs in [our Discord community](https://astro.build/chat).

## Raise an Issue

Is something missing?
Is something wrong?
Could something be better?
Issues are a quick way for you to offer us feedback about the docs.

Before you share, please [see if your issue has already been reported](https://github.com/withastro/docs/issues).

## Edit a Page

Every page on [docs.astro.build](https://docs.astro.build/) has an **Edit this page** button in the sidebar.
You can click that button to edit the source code for that page in **GitHub**.

After you make your changes, click **Commit changes**.
This will automatically create a [fork](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/about-forks) of the docs in your GitHub account with the changes.

Once your edits are ready in GitHub, follow the prompts to **create a pull request** and submit your changes for review.
Every pull request needs to be reviewed by our contributors.

## Develop

To begin developing locally, checkout this project from your machine.

```shell
git clone git@github.com:withastro/docs.git
```

You can install and run the project locally using your preferred package manager.

```shell
npm install

npm start
```

If you’re copying these instructions, remember to [configure this project as a fork](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/configuring-a-remote-for-a-fork).

```shell
git remote add upstream git@github.com:csstools/docs.git
```

At any point, create a branch for your contribution.
We are not strict about branch names.

```shell
git checkout -b add/klingon-language
```

That’s it.
As you [open a pull request](https://github.com/withastro/astro/compare), please include a clear title and description.

```markdown
# Add Klingon language to Getting Started page

This adds the Klingon language and also updates the sidebar and language selection components.
```

Thank you for helping make the docs awesome.
And please, [come chat with us](https://astro.build/chat) if you have any questions.

## Deploy

Every pull request generates a preview using **Netlify** for anyone to see.

Use the **Deploy Preview** of your pull request to review and share your changes.

The docs site will be automatically updated whenever pull requests are merged.

## Next Steps

- [Read the docs](https://docs.astro.build/)
- [Fork the docs](https://github.com/withastro/docs/fork)
- [Raise an issue](https://github.com/withastro/docs/issues/new)
- [Discuss the docs](https://discord.gg/cZDZU3hJHc)