|
1 | | -# GitHub Docs <!-- omit in toc --> |
2 | | - |
3 | | -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). |
| 1 | +# lrttr2/docs <!-- omit in toc --> |
4 | 2 |
|
| 3 | +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. |
5 | 4 |
|
6 | 5 | ## Quick links by contributor type |
7 | 6 |
|
8 | 7 | * **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. |
9 | 8 |
|
10 | | -* **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. |
11 | | - |
12 | | -## How we sync changes across Docs repositories |
13 | | - |
14 | | -There are two GitHub Docs repositories: |
15 | | - |
16 | | -- **`github/docs`** (public): Open to external contributions |
| 9 | +* **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. |
17 | 10 |
|
18 | | -- **`github/docs-internal`** (private): For GitHub employee contributions. |
| 11 | +## Repository Structure |
19 | 12 |
|
20 | | -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`. |
| 13 | +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. |
21 | 14 |
|
22 | | -**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. |
| 15 | +- **`/content`** - Markdown content files for documentation articles |
| 16 | +- **`/src`** - Application source code (TypeScript) |
| 17 | +- **`/assets`** - Images, styles, and other static assets |
| 18 | +- **`/contributing`** - Contribution guides and documentation |
| 19 | +- **`/.github`** - GitHub configuration and workflows |
23 | 20 |
|
24 | | -## New to contributing |
| 21 | +## Getting started |
25 | 22 |
|
26 | | -Here are some resources to help you get started with open source contributions: |
| 23 | +If you're new to this repository or contributing to documentation, here are some resources: |
27 | 24 |
|
28 | 25 | * [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) |
29 | 26 | * [Set up Git](https://docs.github.com/en/get-started/git-basics/set-up-git) |
30 | 27 | * [GitHub flow](https://docs.github.com/en/get-started/using-github/github-flow) |
31 | 28 | * [Collaborating with pull requests](https://docs.github.com/en/github/collaborating-with-pull-requests) |
32 | 29 |
|
| 30 | +## Tech Stack |
| 31 | + |
| 32 | +This repository is primarily built with: |
| 33 | + |
| 34 | +* **TypeScript** (97.7%) - Application logic and site functionality |
| 35 | +* **SCSS** (1.5%) - Styling |
| 36 | +* **Other** (0.8%) - Additional tooling and configuration |
| 37 | + |
33 | 38 | ## License |
34 | 39 |
|
35 | | -This project is dual-licensed under: |
| 40 | +This project is dual-licensed: |
36 | 41 |
|
37 | 42 | * **Creative Commons Attribution 4.0** - for documentation and content in the assets, content, and data folders (see [LICENSE](LICENSE)) |
38 | | -* **MIT License** - for code (see [LICENSE-CODE](LICENSE-CODE)) |
| 43 | +* **MIT License** - for code (see [LICENSE-CODE](LICENSE-CODE)) |
0 commit comments