From 68b2c7593a02f7466e8d3177061910f1e6073dff Mon Sep 17 00:00:00 2001 From: lrttr2 <164699007+lrttr2@users.noreply.github.com> Date: Sun, 19 Apr 2026 15:39:37 +0200 Subject: [PATCH 1/2] Update README.md with new content. --- README.md | 39 ++++++++++++++++++++++----------------- 1 file changed, 22 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index f5730b788246..06b193dc57b9 100644 --- a/README.md +++ b/README.md @@ -1,38 +1,43 @@ -# GitHub Docs - -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). +# lrttr2/docs +Welcome to lrttr2/docs! This is a fork of GitHub's open-source documentation repository for docs.github.com. Contributions and community feedback are welcome. For full contributing guidelines, see the repository's CONTRIBUTING.md in the .github directory. ## Quick links by contributor type * **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. -* **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. - -## How we sync changes across Docs repositories - -There are two GitHub Docs repositories: - -- **`github/docs`** (public): Open to external contributions +* **Open source contributors:** See [CONTRIBUTING.md](https://github.com/github/docs/blob/main/.github/CONTRIBUTING.md) in the upstream `github/docs` repository for a quick-start summary. -- **`github/docs-internal`** (private): For GitHub employee contributions. +## Repository Structure -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`. +This repository contains the Markdown content, assets, and site configuration used to build docs.github.com. The upstream repository is `github/docs` (public), which is open to external contributions. -**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. +- **`/content`** - Markdown content files for documentation articles +- **`/src`** - Application source code (TypeScript) +- **`/assets`** - Images, styles, and other static assets +- **`/contributing`** - Contribution guides and documentation +- **`/.github`** - GitHub configuration and workflows -## New to contributing +## Getting started -Here are some resources to help you get started with open source contributions: +If you're new to this repository or contributing to documentation, here are some resources: * [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) +## Tech Stack + +This repository is primarily built with: + +* **TypeScript** (97.7%) - Application logic and site functionality +* **SCSS** (1.5%) - Styling +* **Other** (0.8%) - Additional tooling and configuration + ## License -This project is dual-licensed under: +This project is dual-licensed: * **Creative Commons Attribution 4.0** - for documentation and content in the assets, content, and data folders (see [LICENSE](LICENSE)) -* **MIT License** - for code (see [LICENSE-CODE](LICENSE-CODE)) +* **MIT License** - for code (see [LICENSE-CODE](LICENSE-CODE)) \ No newline at end of file From 7706b48a9d673c4ef40b0cfecf4f75bdfddab666 Mon Sep 17 00:00:00 2001 From: lrttr2 <164699007+lrttr2@users.noreply.github.com> Date: Sun, 19 Apr 2026 15:56:57 +0200 Subject: [PATCH 2/2] Delete README.md --- README.md | 43 ------------------------------------------- 1 file changed, 43 deletions(-) delete mode 100644 README.md diff --git a/README.md b/README.md deleted file mode 100644 index 06b193dc57b9..000000000000 --- a/README.md +++ /dev/null @@ -1,43 +0,0 @@ -# lrttr2/docs - -Welcome to lrttr2/docs! This is a fork of GitHub's open-source documentation repository for docs.github.com. Contributions and community feedback are welcome. For full contributing guidelines, see the repository's CONTRIBUTING.md in the .github directory. - -## Quick links by contributor type - -* **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. - -* **Open source contributors:** See [CONTRIBUTING.md](https://github.com/github/docs/blob/main/.github/CONTRIBUTING.md) in the upstream `github/docs` repository for a quick-start summary. - -## Repository Structure - -This repository contains the Markdown content, assets, and site configuration used to build docs.github.com. The upstream repository is `github/docs` (public), which is open to external contributions. - -- **`/content`** - Markdown content files for documentation articles -- **`/src`** - Application source code (TypeScript) -- **`/assets`** - Images, styles, and other static assets -- **`/contributing`** - Contribution guides and documentation -- **`/.github`** - GitHub configuration and workflows - -## Getting started - -If you're new to this repository or contributing to documentation, here are some resources: - -* [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) - -## Tech Stack - -This repository is primarily built with: - -* **TypeScript** (97.7%) - Application logic and site functionality -* **SCSS** (1.5%) - Styling -* **Other** (0.8%) - Additional tooling and configuration - -## License - -This project is dual-licensed: - -* **Creative Commons Attribution 4.0** - for documentation and content in the assets, content, and data folders (see [LICENSE](LICENSE)) -* **MIT License** - for code (see [LICENSE-CODE](LICENSE-CODE)) \ No newline at end of file