diff --git a/README.md b/README.md index 69090a601896..e5e45e0173b8 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,19 @@ GitHub's Docs team works on pre-production content in a private repo that regula 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. +## Overview + +This repository contains the documentation website code and Markdown source files for docs.github.com. Here is a general overview of the repository: + +* **Documentation content** ๐Ÿ“„: The main documentation content is located in the `content` directory. It includes various Markdown files that cover different topics such as `content/get-started/index.md`, `content/index.md`, and more. +* **Configuration files** โš™๏ธ: The repository contains several configuration files such as `.editorconfig`, `.env.example`, and `next.config.js` to manage the development environment and project settings. +* **GitHub workflows** ๐Ÿš€: The `.github/workflows` directory contains various GitHub Actions workflows for automating tasks like `.github/workflows/auto-close-dependencies.yml`, `.github/workflows/azure-prod-build-deploy.yml`, and `.github/workflows/test.yml`. +* **Assets** ๐Ÿ–ผ๏ธ: The `assets` directory contains images, CSV files, and other static assets used in the documentation, such as `assets/images/README.md` and `assets/ghes-3-12-opentelemetry-attribute-mappings.csv`. +* **Source code** ๐Ÿ’ป: The `src` directory contains the main application code, organized by subject folders. Each folder represents a major capability of the documentation site, such as `src/archives`, `src/assets`, and more. For example, `src/archives/lib/is-archived-version.js` and `src/assets/lib/image-density.js`. +* **Tests** ๐Ÿงช: The repository includes tests to ensure the functionality of the documentation site. For example, `src/archives/tests/deprecated-enterprise-versions.js` contains tests related to deprecated enterprise versions. +* **Package management** ๐Ÿ“ฆ: The `package.json` file lists the dependencies and scripts used in the project, while the `Dockerfile` and `docker-compose.yaml` files are used for containerization. +* **Contributing guidelines** ๐Ÿค: The repository provides guidelines for contributing to the project in the `README.md` and `contributing/README.md` files. + ## 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](https://docs.github.com/en/contributing/collaborating-on-github-docs/about-contributing-to-github-docs)." diff --git a/content/index.md b/content/index.md index f07db6050ed3..6f662970c2e2 100644 --- a/content/index.md +++ b/content/index.md @@ -1,5 +1,5 @@ --- -title: '{% data variables.product.product_name %}{% ifversion fpt or ghec%}.com{% endif %} Help Documentation' +title: GitHub Documentation featuredLinks: gettingStarted: - /get-started/getting-started-with-git/set-up-git @@ -171,3 +171,6 @@ externalProducts: href: 'https://docs.npmjs.com/' external: true --- + +Welcome to the GitHub Documentation site! Here, you will find comprehensive guides and documentation to help you get started with GitHub, understand its features, and make the most out of your experience. + diff --git a/contributing/README.md b/contributing/README.md index 4d4322240dbd..ba41b9e81e5c 100644 --- a/contributing/README.md +++ b/contributing/README.md @@ -17,3 +17,16 @@ Here, you'll find additional information that might be helpful as you work on a - [Tests](/tests/README.md) - We use tests to ensure content will render correctly on the site. Tests run automatically in your PR, and sometimes it's also helpful to run them locally. You can also read the READMEs in the `src/` directory to learn more about the features of the docs site. + +## Repository Overview + +This repository contains the documentation website code and Markdown source files for docs.github.com. Here is a general overview of the repository: + +* **Documentation content** ๐Ÿ“„: The main documentation content is located in the `content` directory. It includes various Markdown files that cover different topics such as `content/get-started/index.md`, `content/index.md`, and more. +* **Configuration files** โš™๏ธ: The repository contains several configuration files such as `.editorconfig`, `.env.example`, and `next.config.js` to manage the development environment and project settings. +* **GitHub workflows** ๐Ÿš€: The `.github/workflows` directory contains various GitHub Actions workflows for automating tasks like `.github/workflows/auto-close-dependencies.yml`, `.github/workflows/azure-prod-build-deploy.yml`, and `.github/workflows/test.yml`. +* **Assets** ๐Ÿ–ผ๏ธ: The `assets` directory contains images, CSV files, and other static assets used in the documentation, such as `assets/images/README.md` and `assets/ghes-3-12-opentelemetry-attribute-mappings.csv`. +* **Source code** ๐Ÿ’ป: The `src` directory contains the main application code, organized by subject folders. Each folder represents a major capability of the documentation site, such as `src/archives`, `src/assets`, and more. For example, `src/archives/lib/is-archived-version.js` and `src/assets/lib/image-density.js`. +* **Tests** ๐Ÿงช: The repository includes tests to ensure the functionality of the documentation site. For example, `src/archives/tests/deprecated-enterprise-versions.js` contains tests related to deprecated enterprise versions. +* **Package management** ๐Ÿ“ฆ: The `package.json` file lists the dependencies and scripts used in the project, while the `Dockerfile` and `docker-compose.yaml` files are used for containerization. +* **Contributing guidelines** ๐Ÿค: The repository provides guidelines for contributing to the project in the `README.md` and `contributing/README.md` files. diff --git a/package.json b/package.json index d4bcfecc5465..2a62735a478c 100644 --- a/package.json +++ b/package.json @@ -9,6 +9,7 @@ "url": "https://github.com/github/docs" }, "type": "module", + "description": "This repository contains the documentation website code and Markdown source files for docs.github.com. Here is a general overview of the repository:\n\n* **Documentation content** ๐Ÿ“„: The main documentation content is located in the `content` directory. It includes various Markdown files that cover different topics such as `content/get-started/index.md`, `content/index.md`, and more.\n* **Configuration files** โš™๏ธ: The repository contains several configuration files such as `.editorconfig`, `.env.example`, and `next.config.js` to manage the development environment and project settings.\n* **GitHub workflows** ๐Ÿš€: The `.github/workflows` directory contains various GitHub Actions workflows for automating tasks like `.github/workflows/auto-close-dependencies.yml`, `.github/workflows/azure-prod-build-deploy.yml`, and `.github/workflows/test.yml`.\n* **Assets** ๐Ÿ–ผ๏ธ: The `assets` directory contains images, CSV files, and other static assets used in the documentation, such as `assets/images/README.md` and `assets/ghes-3-12-opentelemetry-attribute-mappings.csv`.\n* **Source code** ๐Ÿ’ป: The `src` directory contains the main application code, organized by subject folders. Each folder represents a major capability of the documentation site, such as `src/archives`, `src/assets`, and more. For example, `src/archives/lib/is-archived-version.js` and `src/assets/lib/image-density.js`.\n* **Tests** ๐Ÿงช: The repository includes tests to ensure the functionality of the documentation site. For example, `src/archives/tests/deprecated-enterprise-versions.js` contains tests related to deprecated enterprise versions.\n* **Package management** ๐Ÿ“ฆ: The `package.json` file lists the dependencies and scripts used in the project, while the `Dockerfile` and `docker-compose.yaml` files are used for containerization.\n* **Contributing guidelines** ๐Ÿค: The repository provides guidelines for contributing to the project in the `README.md` and `contributing/README.md` files.", "imports": { "#src/*": { "default": "./src/*"