From e58134a571d5a4361c9150c16fa13800ab89e92d Mon Sep 17 00:00:00 2001 From: Amb1guousRaccoon <139561650+Amb1guousRaccoon@users.noreply.github.com> Date: Fri, 1 Mar 2024 12:13:59 -0500 Subject: [PATCH] [skip ci] change Github to GitHub in README (#1156) Co-authored-by: Amb1guousRaccoon --- README.adoc | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.adoc b/README.adoc index 456495e922..a73f3c43b1 100644 --- a/README.adoc +++ b/README.adoc @@ -106,21 +106,21 @@ Hit CTRL-C to stop the server ---- -== Releasing Starknet docs on Github (for Admins only) +== Releasing Starknet docs on GitHub (for Admins only) _The high-level process for releasing documentation changes in this repository._ During the course of content development, writers merge branches with changes either directly into `main`, into a secondary branch as needed, where these changes wait until we are ready to release them—that is, post them to link:https://docs.starknet.io[docs.starknet.io]. -Github actions create Git tags and releases that appear at the repo’s link:https://github.com/starknet-community-libs/starknet-docs/releases[Releases] and link:https://github.com/starknet-community-libs/starknet-docs/tags[Tags] pages. +GitHub actions create Git tags and releases that appear at the repo’s link:https://github.com/starknet-community-libs/starknet-docs/releases[Releases] and link:https://github.com/starknet-community-libs/starknet-docs/tags[Tags] pages. -When a feature branch is merged into the `main` branch, a github action creates a release tag in the format `v..` and updates `CHANGELOG.md`. It then publishes the new content to docs.starknet.io. +When a feature branch is merged into the `main` branch, a GitHub action creates a release tag in the format `v..` and updates `CHANGELOG.md`. It then publishes the new content to docs.starknet.io. === Procedure Merging a feature branch to `main` automatically publishes changes in the feature branch. No additional steps are required. -Github increments the version numbers in `package.json` and `package-lock.json`, and updates `CHANGELOG.md` with the descriptions of each PR that was just merged into `main`. +GitHub increments the version numbers in `package.json` and `package-lock.json`, and updates `CHANGELOG.md` with the descriptions of each PR that was just merged into `main`. . Update your local `main` branch from the remote `main` branch using one of the following: * Pull the changes: