The open-source repo for docs.github.com

docs hacktoberfest works-with-codespaces

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

Laura Coursen e3de257eba Fix permissions statement (#30793 )		2022-09-15 07:16:01 -05:00
.devcontainer	Increase memory of default codespace (#29992 )	2022-08-16 13:07:43 +00:00
.github	upgrade docker/setup-buildx-action to version 1.7.0 (#30580 )	2022-09-14 16:26:58 +00:00
.husky	chore: remove git.io (#17417 )	2022-04-27 06:43:01 -07:00
.vscode	simplify find-page middleware (#30642 )	2022-09-12 12:12:07 +00:00
assets/images	Merge branch 'main' into saritai/autolink-format-setting	2022-09-13 13:54:04 -04:00
components	auto-refresh content (#30689 )	2022-09-14 16:58:27 +00:00
content	Fix permissions statement (#30793 )	2022-09-15 07:16:01 -05:00
contributing	Update types-of-contributions.md	2022-09-13 17:08:55 -05:00
data	Action ran graphql script"update-files"	2022-09-14 16:35:54 +00:00
docs	Add Observability docs to service catalog (#16878 )	2020-12-12 00:04:54 +00:00
lib	update search indexes	2022-09-15 10:55:38 +00:00
middleware	favor more exact spelling searches (#30741 )	2022-09-13 18:59:14 +00:00
pages	Test JSON API without enabling dedicated search results page (#30542 )	2022-09-06 17:05:22 +00:00
script	favor more exact spelling searches (#30741 )	2022-09-13 18:59:14 +00:00
stylesheets	Update permissions statement design (#30703 )	2022-09-13 16:19:53 +00:00
tests	re-read content on every request (#30646 )	2022-09-13 13:06:33 +00:00
translations	Remove CrowdIn logs (#30770 )	2022-09-14 17:26:31 +00:00
.babelrc	NextJS 12.1.6 (#26102 )	2022-06-28 12:57:38 +00:00
.dockerignore	Public Repo Azure Preview Environments (#25206 )	2022-02-10 14:14:40 -06:00
.editorconfig	…
.env.example	Removing algolia (#20633 )	2021-08-05 13:10:51 -04:00
.eslintrc.cjs	Next12 now supports ESM (#29295 )	2022-07-26 17:53:23 +00:00
.gitattributes	Update references to "Git reference" (#16968 )	2022-04-27 10:38:38 +00:00
.gitignore	Apply suggestions from code review	2022-09-09 15:21:46 +10:00
.node-version	feat: upgrade to node v16, package-lock.json v2, remove aws-sdk	2021-05-20 13:32:19 -07:00
.npmrc	…
.prettierignore	simplify find-page middleware (#30642 )	2022-09-12 12:12:07 +00:00
.prettierrc.json	Pretty format (#20352 )	2021-07-14 14:35:01 -07:00
1	Update OpenAPI Descriptions (#30785 )	2022-09-15 10:40:25 +00:00
CODE_OF_CONDUCT.md	Add restriction on private contact of community members without permission (#16570 )	2020-11-23 11:27:30 -07:00
CONTRIBUTING.md	Update learning lab links to skills (#28135 )	2022-06-06 15:34:57 +00:00
Dockerfile	Remove feature flags (#29968 )	2022-08-16 11:23:02 +00:00
Dockerfile.openapi_decorator	add `data` directory (#22529 )	2021-11-02 07:35:03 -07:00
LICENSE	…
LICENSE-CODE	Edit as per review	2022-03-21 21:10:03 +05:30
README.md	Update README.md	2022-08-04 10:40:02 -07:00
azure-preview-env-template.json	Remove Caddy from preview envs (#26336 )	2022-03-22 10:47:53 -04:00
codespaces-settings.json	Create codespaces-settings.json	2022-04-07 15:06:37 +01:00
docker-compose.prod.tmpl.yaml	fix: use prod registry for datadog image (#28365 )	2022-06-09 13:39:57 -05:00
docker-compose.staging.tmpl.yaml	Remove the Signal Science container from the staging template.	2022-05-30 15:22:14 -06:00
docker-compose.yaml	Accept glob patterns for source files in openapi-check script (#18965 )	2021-04-26 21:56:12 +00:00
feature-flags.json	Remove FEATURE_NEXTJS Flag Part 1 (#20176 )	2021-07-16 14:54:25 -07:00
jest-puppeteer.config.cjs	Next12 now supports ESM (#29295 )	2022-07-26 17:53:23 +00:00
jest.config.js	Create a translations test suite (#30000 )	2022-08-25 12:38:03 -07:00
jest.setup.js	Fail on console.error in tests with failOnConsole (#25600 )	2022-02-25 10:49:27 -06:00
next-env.d.ts	remove need for styled-jsx construct (#28749 )	2022-06-28 11:53:35 +00:00
next.config.js	derive NextJS languages from our lib/languages.js (#30281 )	2022-08-26 14:45:17 +00:00
nodemon.json	re-read content on every request (#30646 )	2022-09-13 13:06:33 +00:00
ownership.yaml	Update ownership.yaml	2022-09-12 09:27:40 -07:00
package-lock.json	re-instate optional darwin swc dependencies (#30612 )	2022-09-08 11:38:11 -04:00
package.json	connect to ES 7.11 (#30462 )	2022-09-06 11:50:40 +00:00
server.js	Next12 now supports ESM (#29295 )	2022-07-26 17:53:23 +00:00
start-server.js	Remove feature flags (#29968 )	2022-08-16 11:23:02 +00:00
tsconfig.json	Refactor display-platform-specific-content (#22665 )	2021-11-12 14:40:35 +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 left corner of this document to get to a specific section of this guide quickly.

Contributing

See the contributing guide for detailed instructions on how to get started with our project.

We accept different types of contributions, including some that don't require you to write a single line of code.

On the GitHub Docs site, you can click 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.

For more complex contributions, you can 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 existing issues for something to work on. When ready, check out Getting Started with Contributing for detailed instructions.

Join us in discussions

We use GitHub Discussions to talk about all sorts of topics related to documentation and this site. For example: if you'd like help troubleshooting a PR, have a great new idea, or want to share something amazing you've learned in our docs, join us in the discussions.

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 Documentation 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 ✨!