Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[ADP-3072] switch documentation rendering tool from emanote to mdbook #4006

Merged
merged 5 commits into from
Jul 1, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions .github/workflows/publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -55,18 +55,18 @@ jobs:
Source commit: ${{ github.sha }}

- name: "❄ Install dependencies"
run: "nix develop .#docs --command emanote --version"
run: "nix develop .#docs --command mdbook --version"

- name: "📸 Build Documentation"
run: |
build_dir="$PUBLISH_DIR"
if [ -n "$PR_NUMBER" ]; then
build_dir="$build_dir/_pr/$PR_NUMBER"
nix develop .#docs -c yq --in-place -y '.template.baseUrl|=.+"_pr/\(env.PR_NUMBER)/"' docs/.deploy/github/index.yaml
fi
# if [ -n "$PR_NUMBER" ]; then
# build_dir="$build_dir/_pr/$PR_NUMBER"
# nix develop .#docs -c yq --in-place -y '.template.baseUrl|=.+"_pr/\(env.PR_NUMBER)/"' docs/.deploy/github/index.yaml
# fi

mkdir -p "$build_dir"
nix develop .#docs -c emanote --layers "docs;docs/.deploy/github" gen "$build_dir"
nix develop .#docs -c mdbook build -d "$build_dir" "docs/site"
./scripts/gh/update-docs.sh "$build_dir" ${{ steps.versions.outputs.tag }}

- name: "📘 Publish"
Expand All @@ -77,6 +77,6 @@ jobs:
enable_jekyll: false
publish_dir: ${{ env.PUBLISH_DIR }}
keep_files: true
user_name: "William King Noel Bot"
user_email: "adrestia@iohk.io"
user_name: "Cardano Wallet Documentation Bot"
user_email: "adrestia@cardano-foundation.io"
full_commit_message: ${{ steps.versions.outputs.commit_message }}
2 changes: 0 additions & 2 deletions docs/.deploy/github/index.yaml

This file was deleted.

1 change: 1 addition & 0 deletions docs/.direnv/flake-profile
1 change: 1 addition & 0 deletions docs/.direnv/flake-profile-1-link
1 change: 1 addition & 0 deletions docs/.direnv/flake-profile-2-link
14 changes: 0 additions & 14 deletions docs/.vscode/extensions.json

This file was deleted.

26 changes: 0 additions & 26 deletions docs/.vscode/settings.json

This file was deleted.

9 changes: 0 additions & 9 deletions docs/archives.md

This file was deleted.

27 changes: 0 additions & 27 deletions docs/archives/jormungandr.md

This file was deleted.

118 changes: 0 additions & 118 deletions docs/archives/jormungandr/Docker-jormungandr.md

This file was deleted.

Loading