Skip to content

Commit 68b2c75

Browse files
committed
Update README.md with new content.
1 parent 97bc4dd commit 68b2c75

File tree

1 file changed

+22
-17
lines changed

1 file changed

+22
-17
lines changed

README.md

Lines changed: 22 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,43 @@
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 -->
42

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.
54

65
## Quick links by contributor type
76

87
* **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.
98

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.
1710

18-
- **`github/docs-internal`** (private): For GitHub employee contributions.
11+
## Repository Structure
1912

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.
2114

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
2320

24-
## New to contributing
21+
## Getting started
2522

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:
2724

2825
* [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)
2926
* [Set up Git](https://docs.github.com/en/get-started/git-basics/set-up-git)
3027
* [GitHub flow](https://docs.github.com/en/get-started/using-github/github-flow)
3128
* [Collaborating with pull requests](https://docs.github.com/en/github/collaborating-with-pull-requests)
3229

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+
3338
## License
3439

35-
This project is dual-licensed under:
40+
This project is dual-licensed:
3641

3742
* **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

Comments
 (0)