The open-source repo for docs.github.com
Перейти к файлу
Kevin Heis 1bd1feba0d
Condense repo-sync process (#37822)
2023-06-14 15:00:15 +00:00
.devcontainer Update devcontainer.json 2023-03-27 17:18:37 +01:00
.github Condense repo-sync process (#37822) 2023-06-14 15:00:15 +00:00
.husky Rm translations directory (#33720) 2023-01-03 12:44:48 -08:00
.vscode Translation cleanup (#33738) 2023-01-04 18:06:51 +00:00
assets Admin Visibility & Access to EMU namespace repositories (#37419) 2023-06-13 15:01:00 +00:00
components Stop using currentProductTree in Header component (#37737) 2023-06-12 18:14:26 +00:00
content Merge pull request #37815 from github/repo-sync 2023-06-14 11:01:11 -04:00
contributing Added adaptive theme octicons (#37802) 2023-06-14 12:13:53 +00:00
data Merge pull request #37735 from github/copy-to-commonmark-compliant 2023-06-13 10:48:18 -07:00
docs Add Observability docs to service catalog (#16878) 2020-12-12 00:04:54 +00:00
lib Merge pull request #37735 from github/copy-to-commonmark-compliant 2023-06-13 10:48:18 -07:00
middleware Correct translation content from reusables too (#37722) 2023-06-13 11:49:18 +00:00
pages Import from the src directory in Node using `#src` (#37578) 2023-06-05 21:44:20 +00:00
script Create and migrate observability directory (#37448) 2023-06-05 15:42:53 +00:00
src merge allOf JSON schema properties OpenAPI (#37821) 2023-06-13 22:27:45 +00:00
stylesheets Annotations frontend (#37724) 2023-06-12 20:53:31 +00:00
tests Correct translation content from reusables too (#37722) 2023-06-13 11:49:18 +00:00
.babelrc NextJS 12.1.6 (#26102) 2022-06-28 12:57:38 +00:00
.dockerignore Update .dockerignore (#34318) 2023-02-07 18:50:03 +00:00
.editorconfig chore: Add EditorConfig for IDE whitespace 2020-11-03 10:59:19 -05:00
.env.example Translation cleanup (#33738) 2023-01-04 18:06:51 +00:00
.eslintrc.cjs Create and migrate observability directory (#37448) 2023-06-05 15:42:53 +00:00
.gitattributes Address 20 En-US Standardizations (#25095) 2023-04-27 12:48:41 +00:00
.gitignore Delete .linkinator/full.log file (#36733) 2023-05-01 13:57:47 +00:00
.npmrc Automatically run npm install when running npm start (#35283) 2023-03-07 18:38:07 +00:00
.prettierignore ignore repos prettier (#35710) 2023-03-21 18:03:27 +00:00
.prettierrc.json remove jsxBracketSameLine prettier config option (#32602) 2022-11-15 15:53:03 +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 Make images accessible in the `/images` root directory (#35016) 2023-02-27 15:26:00 +00:00
Dockerfile Upgrade Dockerfile to latest node:18.16-alpine (#36894) 2023-05-05 15:41:18 +00:00
Dockerfile.openapi_decorator Bump node from 18.14-alpine to 18.15-alpine (#35843) 2023-03-24 00:10:43 +00:00
LICENSE Reorg LICENSE files to be more discoverable (#204) 2020-10-07 15:11:49 -07:00
LICENSE-CODE Update MIT License year from `2022` -> `2023` (#25557) 2023-05-22 17:20:55 +00:00
README.md Typo (#25659) 2023-05-24 02:14:31 +00:00
azure-preview-env-template.json Preview deploys with translations (#37285) 2023-06-05 16:23:34 +00:00
codespaces-settings.json Create codespaces-settings.json 2022-04-07 15:06:37 +01:00
docker-compose.prod.tmpl.yaml stop making it possible to set ENABLED_LANGUAGES beyond the hardcoded… (#33567) 2022-12-14 20:33:46 +00:00
docker-compose.staging.tmpl.yaml Revert "Remove ENABLED_LANGUAGES" (#33953) 2023-01-13 17:52:48 +00: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 Remove old browser (headless) tests (#37433) 2023-06-02 16:16:58 +00: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 Move more files into src/webhooks (#36578) 2023-05-10 18:54:56 +00:00
nodemon.json Cli manpage automation (#35169) 2023-03-16 17:55:51 +00:00
ownership.yaml Update ownership.yaml 2022-09-12 09:27:40 -07:00
package-lock.json merge allOf JSON schema properties OpenAPI (#37821) 2023-06-13 22:27:45 +00:00
package.json merge allOf JSON schema properties OpenAPI (#37821) 2023-06-13 22:27:45 +00:00
playwright.config.ts Minimal tests with Playwright (#35322) 2023-03-10 21:22:51 +00:00
server.js [Take 2] Throw error if children entry can't be found, even if early access (#35523) 2023-03-14 13:57:24 +00:00
start-server.js Import from the src directory in Node using `#src` (#37578) 2023-06-05 21:44:20 +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 navigate to a specific section 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 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 !