Skip to content

Commit

Permalink
ci: move guide docs to separate repo (#4751)
Browse files Browse the repository at this point in the history
## Describe your changes
The Penumbra Guide has been moved to its own repo [0], and ported from
mdbook [1] to nextra [2] in the process. As a follow-up, I'm removing
the deprecated mdbook-based guide from the protocol repo, as well as the
corresponding CI workflows.

[0] https://github.com/penumbra-zone/guide
[1] https://rust-lang.github.io/mdBook
[2] https://nextra.site

## Issue ticket number and link
N/A

## Checklist before requesting a review

- [x] If this code contains consensus-breaking changes, I have added the
"consensus-breaking" label. Otherwise, I declare my belief that there
are not consensus-breaking changes, for the following reason:

  > docs and CI changes only, no changes to application code.

Co-authored-by: Conor Schaefer <[email protected]>
  • Loading branch information
conorsch and conorsch authored Jul 24, 2024
1 parent db79574 commit fbdd570
Show file tree
Hide file tree
Showing 59 changed files with 9 additions and 3,263 deletions.
3 changes: 0 additions & 3 deletions .github/workflows/docs-lint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,5 @@ jobs:
- name: Install mdbook dependencies
run: cargo install mdbook mdbook-katex mdbook-mermaid mdbook-linkcheck

- name: Build guide docs
run: cd docs/guide && mdbook build

- name: Build protocol docs
run: cd docs/protocol && mdbook build
12 changes: 0 additions & 12 deletions .github/workflows/notes.yml
Original file line number Diff line number Diff line change
Expand Up @@ -35,18 +35,6 @@ jobs:
# Make sure to install with `+nightly`, because that's the toolchain we'll use for building docs.
run: cargo +nightly install mdbook mdbook-katex mdbook-mermaid mdbook-linkcheck

- name: Build software guide
working-directory: docs/guide
run: mdbook build

- name: Deploy software guide to firebase
uses: w9jds/[email protected]
with:
args: deploy
env:
FIREBASE_TOKEN: ${{ secrets.FIREBASE_TOKEN }}
PROJECT_PATH: docs/guide

- name: Build protocol spec
run: cd docs/protocol && mdbook build

Expand Down
5 changes: 0 additions & 5 deletions docs/guide/.firebaserc

This file was deleted.

4 changes: 4 additions & 0 deletions docs/guide/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Penumbra guide

The source code for the [Penumbra guide](https://guide.penumbra.zone)
has moved to a [separate repository](https://github.com/penumbra-zone/guide).
29 changes: 0 additions & 29 deletions docs/guide/book.toml

This file was deleted.

32 changes: 0 additions & 32 deletions docs/guide/firebase.json

This file was deleted.

68 changes: 0 additions & 68 deletions docs/guide/src/README.md

This file was deleted.

41 changes: 0 additions & 41 deletions docs/guide/src/SUMMARY.md

This file was deleted.

Binary file removed docs/guide/src/assets/interchain-shielded-pool.jpg
Binary file not shown.
1 change: 0 additions & 1 deletion docs/guide/src/cometbft_version.md

This file was deleted.

13 changes: 0 additions & 13 deletions docs/guide/src/dev.md

This file was deleted.

143 changes: 0 additions & 143 deletions docs/guide/src/dev/build.md

This file was deleted.

Loading

0 comments on commit fbdd570

Please sign in to comment.