diff --git a/.github/workflows/sync-openapi.yml b/.github/workflows/sync-openapi.yml index f43b9ccc6666..0c6e5d838de5 100644 --- a/.github/workflows/sync-openapi.yml +++ b/.github/workflows/sync-openapi.yml @@ -57,6 +57,7 @@ jobs: env: # Needed for gh GITHUB_TOKEN: ${{ secrets.DOCS_BOT_PAT_BASE }} + NODE_OPTIONS: '--max-old-space-size=8192' run: | npm run sync-rest -- \ --source-repos rest-api-description models-gateway \ diff --git a/Dockerfile b/Dockerfile index 426426a4407f..a539cf735871 100644 --- a/Dockerfile +++ b/Dockerfile @@ -8,7 +8,7 @@ # --------------------------------------------------------------- # To update the sha: # https://github.com/github/gh-base-image/pkgs/container/gh-base-image%2Fgh-base-noble -FROM ghcr.io/github/gh-base-image/gh-base-noble:20251010-155737-g547a87a71 AS base +FROM ghcr.io/github/gh-base-image/gh-base-noble:20251016-101023-g0e97a15f4 AS base # Install curl for Node install and determining the early access branch # Install git for cloning docs-early-access & translations repos diff --git a/README.md b/README.md index 01eee7da20ce..4efe56cceeb0 100644 --- a/README.md +++ b/README.md @@ -1,55 +1,30 @@ # GitHub Docs -[![Build GitHub Docs On Codespaces](https://github.com/codespaces/badge.svg)](https://github.com/codespaces/new/?repo=github) -This repository contains the documentation website code and Markdown source files for [docs.github.com](https://docs.github.com). +Welcome to GitHub Docs! GitHub’s documentation is open source, meaning anyone from inside or outside the company can contribute. For full contributing guidelines, visit our [contributing guide](https://docs.github.com/en/contributing) -GitHub's Docs team works on pre-production content in a private repo that regularly syncs with this public repo. +## Quick links by contributor type -Use the table of contents icon Table of contents icon on the top right corner of this document to navigate to a specific section quickly. +* **Hubbers (GitHub employees):** See [CONTRIBUTING.md](https://github.com/github/docs-content/blob/main/CONTRIBUTING.md) in the `docs-content` repository for GitHub-specific processes. -## Contributing +* **Open source contributors:** See [CONTRIBUTING.md](https://github.com/github/docs/blob/main/.github/CONTRIBUTING.md) in the `docs` repository for a quick-start summary. -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](https://docs.github.com/en/contributing/collaborating-on-github-docs/about-contributing-to-github-docs). +## How we sync changes across Docs repositories -### Ways to contribute +There are two GitHub Docs repositories: -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. +- **`github/docs`** (public): Open to external contributions -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](https://docs.github.com/en/contributing/setting-up-your-environment-to-work-on-github-docs). +- **`github/docs-internal`** (private): For GitHub employee contributions. -Contribution call-to-action +The two repositories sync frequently. Content changes in one are reflected in the other. Hubbers might prefer to post in `docs` when working with a customer, but `docs` has limitations on the types of contributions it accepts to safeguard the site and our workflows. Internal contributions should usually go to `docs-internal`. -For more complex contributions, please [open an issue in the docs-content repo](https://github.com/github/docs-content/issues/new/choose) describing the changes you'd like to see. +**Important:** The `docs` repository accepts contributions to content files (`.md` files in `/content` and select `/data` sections like reusables only). Infrastructure files, workflows, and site-building code are not open for external modification. -If you're looking for a way to contribute, you can scan through our [help wanted board](https://github.com/github/docs/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22) to find open issues already approved for work. +## New to contributing -### And that's it! +Here are some resources to help you get started with open source contributions: -If you're having trouble with your GitHub account, contact [Support](https://support.github.com). - -That's how you can easily become a member of the GitHub Docs community. :sparkles: - -## 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: - -- [content/README.md](content/README.md) -- [content/graphql/README.md](content/graphql/README.md) -- [content/rest/README.md](content/rest/README.md) -- [contributing/README.md](contributing/README.md) -- [data/README.md](data/README.md) -- [data/reusables/README.md](data/reusables/README.md) -- [data/variables/README.md](data/variables/README.md) -- [src/README.md](src/README.md) - -## License - -The GitHub product documentation in the assets, content, and data folders are licensed under a [CC-BY license](LICENSE). - -All other code in this repository is licensed under the [MIT license](LICENSE-CODE). - -When using the GitHub logos, be sure to follow the [GitHub logo guidelines](https://github.com/logos). - -## Thanks :purple_heart: - -Thanks for all your contributions and efforts towards improving the GitHub documentation. We thank you for being part of our :sparkles: community :sparkles:! +* [Finding ways to contribute to open source on GitHub](https://docs.github.com/en/get-started/exploring-projects-on-github/finding-ways-to-contribute-to-open-source-on-github) +* [Set up Git](https://docs.github.com/en/get-started/git-basics/set-up-git) +* [GitHub flow](https://docs.github.com/en/get-started/using-github/github-flow) +* [Collaborating with pull requests](https://docs.github.com/en/github/collaborating-with-pull-requests) diff --git a/content/copilot/how-tos/configure-custom-instructions/add-repository-instructions.md b/content/copilot/how-tos/configure-custom-instructions/add-repository-instructions.md index 4b12d26d77e6..6550daeefee0 100644 --- a/content/copilot/how-tos/configure-custom-instructions/add-repository-instructions.md +++ b/content/copilot/how-tos/configure-custom-instructions/add-repository-instructions.md @@ -221,7 +221,7 @@ Once saved, these instructions will apply to the current project in Eclipse that * **Agent instructions** are used by AI agents. - You can create one or more `AGENTS.md` files, stored anywhere within the repository. When {% data variables.product.prodname_copilot_short %} is working, the nearest `AGENTS.md` file in the directory tree will take precedence. For more information, see the [openai/agents.md repository](https://github.com/openai/agents.md). + {% data reusables.copilot.custom-instructions-agents %} Alternatively, you can use a single `CLAUDE.md` or `GEMINI.md` file stored in the root of the repository. @@ -257,7 +257,10 @@ Once saved, these instructions will apply to the current project in Eclipse that * **Agent instructions** are used by AI agents. - For {% data variables.copilot.copilot_chat_short %} in {% data variables.product.prodname_vscode_shortname %}, instructions must be in a file called `AGENTS.md` in the root of the workspace. For more information, see the [openai/agents.md repository](https://github.com/openai/agents.md). + {% data reusables.copilot.custom-instructions-agents %} + + > [!NOTE] + > Support of `AGENTS.md` files outside of the workspace root is currently turned off by default. For details of how to enable this feature, see [Use custom instructions in VS Code](https://code.visualstudio.com/docs/copilot/customization/custom-instructions#_use-an-agentsmd-file) in the {% data variables.product.prodname_vscode_shortname %} documentation. ## Creating repository-wide custom instructions diff --git a/data/reusables/code-scanning/codeql-query-tables/rust.md b/data/reusables/code-scanning/codeql-query-tables/rust.md index 8c41ed1cffd3..d57334d27f41 100644 --- a/data/reusables/code-scanning/codeql-query-tables/rust.md +++ b/data/reusables/code-scanning/codeql-query-tables/rust.md @@ -3,6 +3,7 @@ | Query name | Related CWEs | Default | Extended | {% data variables.copilot.copilot_autofix_short %} | | --- | --- | --- | --- | --- | | [Access of invalid pointer](https://codeql.github.com/codeql-query-help/rust/rust-access-invalid-pointer/) | 476, 825 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "x" aria-label="Not included" %} | +| ['Secure' attribute is not set to true](https://codeql.github.com/codeql-query-help/rust/rust-insecure-cookie/) | 319, 614 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "x" aria-label="Not included" %} | | [Cleartext logging of sensitive information](https://codeql.github.com/codeql-query-help/rust/rust-cleartext-logging/) | 312, 359, 532 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "x" aria-label="Not included" %} | | [Cleartext storage of sensitive information in a database](https://codeql.github.com/codeql-query-help/rust/rust-cleartext-storage-database/) | 312 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "x" aria-label="Not included" %} | | [Cleartext transmission of sensitive information](https://codeql.github.com/codeql-query-help/rust/rust-cleartext-transmission/) | 319 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "x" aria-label="Not included" %} | diff --git a/data/reusables/copilot/custom-instructions-agents.md b/data/reusables/copilot/custom-instructions-agents.md new file mode 100644 index 000000000000..6daa16cd9ac9 --- /dev/null +++ b/data/reusables/copilot/custom-instructions-agents.md @@ -0,0 +1 @@ +You can create one or more `AGENTS.md` files, stored anywhere within the repository. When {% data variables.product.prodname_copilot_short %} is working, the nearest `AGENTS.md` file in the directory tree will take precedence. For more information, see the [openai/agents.md repository](https://github.com/openai/agents.md). diff --git a/data/reusables/copilot/repository-custom-instructions-support.md b/data/reusables/copilot/repository-custom-instructions-support.md index 22d0825690d0..4ce9b2716280 100644 --- a/data/reusables/copilot/repository-custom-instructions-support.md +++ b/data/reusables/copilot/repository-custom-instructions-support.md @@ -20,7 +20,7 @@ The following table shows which {% data variables.product.prodname_copilot_short **1:** Repository-wide instructions (using the `.github/copilot-instructions.md` file).
**2:** Repository-wide instructions and path-specific instructions (using `.github/instructions/**/NAME.instructions.md` files).
-**3:** Repository-wide instructions, path-specific instructions, and a single `AGENTS.md` file in the root of the workspace.
+**3:** Repository-wide instructions, path-specific instructions, and agent instructions (using `AGENTS.md` files).
**4:** Repository-wide instructions, path-specific instructions, and agent instructions (using `AGENTS.md`, `CLAUDE.md` or `GEMINI.md` files).
**X:** Custom instructions are not supported.
**N/A:** Feature not available on this platform.