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

Embed static copy of docsite for help view #949

Merged
merged 7 commits into from
Oct 4, 2024
Merged

Conversation

esimkowitz
Copy link
Member

@esimkowitz esimkowitz commented Oct 3, 2024

This will take the latest artifact from the waveterm-docs repo and embed it in the app binary. When the help view is launched, it will be served from our backend. If the embedded copy doesn't exist, such as in unpackaged versions of the app or in locally packaged versions, it will use the hosted site instead.

There is a sibling PR in the docs repository to build the embedded version of the app (strips out some external links, removes Algolia DocSearch, updates the baseUrl) wavetermdev/waveterm-docs#46

.github/workflows/build-helper.yml Outdated Show resolved Hide resolved
.github/workflows/build-helper.yml Outdated Show resolved Hide resolved
frontend/app/view/helpview/helpview.less Outdated Show resolved Hide resolved
frontend/app/view/helpview/helpview.tsx Outdated Show resolved Hide resolved
pkg/web/web.go Outdated Show resolved Hide resolved
@esimkowitz esimkowitz merged commit 74cda37 into main Oct 4, 2024
5 checks passed
@esimkowitz esimkowitz deleted the evan/static-docsite branch October 4, 2024 03:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant