Skip to content

Commit

Permalink
Instructions for versioning
Browse files Browse the repository at this point in the history
  • Loading branch information
lhstrh committed May 3, 2024
1 parent f1a702a commit 8f56740
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,3 +24,14 @@ In our [deployment workflow](https://github.com/lf-lang/lf-lang.github.io/blob/m
$ yarn build
```
This generates static content in the `build` directory, which gets served using GitHub's static contents hosting service, GitHub Pages.

### Versioning
Instructions for "freezing" the current docs and filing them under a version number, can be found [here](https://docusaurus.io/docs/versioning). Normally, the steps are:
```
git switch main
git pull
git checkout -b v<major>.<minor>.<patch>
yarn docusaurus docs:version <major>.<minor>.<patch>
git add versioned_docs/*
git commit -a -m 'Docs v<major>.<minor>.<patch>'
```

0 comments on commit 8f56740

Please sign in to comment.