The open-source repo for docs.github.com

docs hacktoberfest works-with-codespaces

Перейти к файлу

Andrew Eisenberg b786e9d0a6 Update setting up CodeQL docs (#52436 )		2024-10-07 08:18:59 +00:00
.devcontainer	Update devcontainer.json	2024-07-10 12:58:05 +01:00
.github	Update `orphaned-actions-check.yml` to work with reusables too (#52325 )	2024-09-24 17:02:59 +00:00
.vscode	…
assets	[Fast follow] Secret scanning renaming secondary inbox to 'experimental' (previously 'other') [GA] (#52537 )	2024-10-07 07:54:19 +00:00
content	Update setting up CodeQL docs (#52436 )	2024-10-07 08:18:59 +00:00
contributing	Run zopfli & image compression (#50696 )	2024-05-20 10:23:01 -07:00
data	Enterprise bug fix hour for week of September 23, 2024 (#52477 )	2024-10-07 08:18:10 +00:00
src	Update audit log event data (#52542 )	2024-10-07 07:37:51 +00:00
.dockerignore	…
.editorconfig	…
.env.example	…
.gitattributes	…
.gitignore	Pre-computed pageinfos (#40414 )	2024-01-05 15:21:00 +00:00
.npmrc	…
.prettierignore	Clean up jest (#50177 )	2024-04-16 19:38:46 +00:00
Dockerfile	Lint fixes for dockerfile (#52129 )	2024-08-27 22:03:18 +00:00
Dockerfile.openapi_decorator	…
LICENSE	…
LICENSE-CODE	Update MIT License year from 2023 -> 2024 (#32269 )	2024-03-28 17:02:42 +00:00
README.md	Remove links and mentions of OS Discussions (#49465 )	2024-02-29 21:11:37 +00:00
docker-compose.yaml	…
next.config.js	…
package-lock.json	Bump @octokit/plugin-retry from 6.0.1 to 7.1.2 (#52424 )	2024-09-26 16:35:04 +00:00
package.json	Bump @octokit/plugin-retry from 6.0.1 to 7.1.2 (#52424 )	2024-09-26 16:35:04 +00:00
tsconfig.json	change TypeScript target to es2022 (#51827 )	2024-07-29 22:34:25 +00:00
vitest.config.ts	Use @-imports in TS runtime code (#50470 )	2024-05-06 20:07:34 +00:00

README.md

GitHub Docs

This repository contains the documentation website code and Markdown source files for docs.github.com.

GitHub's Docs team works on pre-production content in a private repo that regularly syncs with this public repo.

Use the table of contents icon on the top right corner of this document to navigate to a specific section quickly.

Contributing

We accept different types of contributions, including some that don't require you to write a single line of code. For detailed instructions on how to get started with our project, see "About contributing to GitHub Docs."

Ways to contribute

On the GitHub Docs site, you can contribute by clicking the Make a contribution button at the bottom of the page to open a pull request for quick fixes like typos, updates, or link fixes.

You can also contribute by creating a local environment or opening a Codespace. For more information, see "Setting up your environment to work on GitHub Docs."

For more complex contributions, please open an issue using the most appropriate issue template to describe the changes you'd like to see.

If you're looking for a way to contribute, you can scan through our help wanted board to find open issues already approved for work.

And that's it!

If you're having trouble with your GitHub account, contact Support.

That's how you can easily become a member of the GitHub Docs community. ✨

READMEs

In addition to the README you're reading right now, this repo includes other READMEs that describe the purpose of each subdirectory in more detail:

License

The GitHub product documentation in the assets, content, and data folders are licensed under a CC-BY license.

All other code in this repository is licensed under the MIT license.

When using the GitHub logos, be sure to follow the GitHub logo guidelines.

Thanks 💜

Thanks for all your contributions and efforts towards improving the GitHub documentation. We thank you for being part of our ✨ community ✨!