Skip to content

Commit

Permalink
Update README and contributing guide with repository overview
Browse files Browse the repository at this point in the history
Add an overview section to the `README.md` file to provide an overview of the repository and its structure.

Update the title and add an introduction to the `content/index.md` file.
* Change the title to "GitHub Documentation"
* Add a brief introduction about the documentation site

Add a repository overview section to the `contributing/README.md` file.
* Provide an overview of the repository and its structure
* Include a brief description of the main directories and their contents
* Mention the purpose of the repository and its main features

Update the description field in the `package.json` file.
* Provide an overview of the repository and its structure
* Include a brief description of the main directories and their contents
* Mention the purpose of the repository and its main features

---

For more details, open the [Copilot Workspace session](https://copilot-workspace.githubnext.com/mustafacco7/docs?shareId=XXXX-XXXX-XXXX-XXXX).
  • Loading branch information
mustafacco7 committed Oct 25, 2024
1 parent 934059c commit 2bdd91b
Show file tree
Hide file tree
Showing 4 changed files with 31 additions and 1 deletion.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <img alt="Table of contents icon" src="./contributing/images/table-of-contents.png" width="25" height="25" /> 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)."
Expand Down
5 changes: 4 additions & 1 deletion content/index.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -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.

13 changes: 13 additions & 0 deletions contributing/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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/*"
Expand Down

0 comments on commit 2bdd91b

Please sign in to comment.