Skip to content

Commit d26df51

Browse files
authored
Update README.adoc
1 parent 4b473f4 commit d26df51

File tree

1 file changed

+0
-37
lines changed

1 file changed

+0
-37
lines changed

README.adoc

Lines changed: 0 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -116,40 +116,3 @@ Available on:
116116
Hit CTRL-C to stop the server
117117
118118
----
119-
120-
== Releasing Starknet docs on GitHub (for Admins only)
121-
122-
_The high-level process for releasing documentation changes in this repository._
123-
124-
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].
125-
126-
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.
127-
128-
When a feature branch is merged into the `main` branch, a GitHub action creates a release tag in the format `v<version>.<major_update>.<minor_update>` and updates `CHANGELOG.md`. It then publishes the new content to docs.starknet.io.
129-
130-
=== Procedure
131-
132-
Merging a feature branch to `main` automatically publishes changes in the feature branch. No additional steps are required.
133-
134-
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`.
135-
. Update your local `main` branch from the remote `main` branch using one of the following:
136-
137-
* Pull the changes:
138-
+
139-
[source,bash]
140-
----
141-
starknet-docs (main) git pull
142-
----
143-
* Do a rebase from `[email protected]:starknet-io/starknet-docs.git`:
144-
+
145-
[source,bash]
146-
----
147-
starknet-docs (main) git fetch origin
148-
starknet-docs (main) git rebase origin/main
149-
----
150-
+
151-
[NOTE]
152-
====
153-
If you are using a fork, then your forked repo is `origin` by default, in which case you should assign the name `upstream` to `[email protected]:starknet-io/starknet-docs.git`. So when rebasing, use `upstream` instead of `origin` in the above commands.
154-
====
155-

0 commit comments

Comments
 (0)