Skip to content

Commit

Permalink
Placing docs in subdirectory to prevent overwriting with every publish (
Browse files Browse the repository at this point in the history
MystenLabs#10782)

## Description 

Places crate documentation in a sub-directory and removes the
force_orphan option so the branch does not clear with every publish. A
redirect will be placed in the gh-pages branch to direct users
appropriately.

## Test Plan 

Local

---
If your changes are not user-facing and not a breaking change, you can
skip the following section. Otherwise, please indicate what changed, and
then add to the Release Notes section as highlighted during the release
process.

### Type of Change (Check all that apply)

- [ ] user-visible impact
- [ ] breaking change for a client SDKs
- [ ] breaking change for FNs (FN binary must upgrade)
- [ ] breaking change for validators or node operators (must upgrade
binaries)
- [ ] breaking change for on-chain data layout
- [ ] necessitate either a data wipe or data migration

### Release notes
  • Loading branch information
ronny-mysten authored Apr 25, 2023
1 parent cfa8da1 commit 8bae23c
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion .github/workflows/ci-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -39,4 +39,4 @@ jobs:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_branch: gh-pages
publish_dir: ./target/doc
force_orphan: true
destination_dir: crates

0 comments on commit 8bae23c

Please sign in to comment.