From 7ea5b6d2dbe100ed87e9853a8f3b6f4bb58fb08b Mon Sep 17 00:00:00 2001 From: Alex Lewin <43247027+alexlwn123@users.noreply.github.com> Date: Thu, 26 Sep 2024 15:00:27 -0400 Subject: [PATCH] fix: base url, links, gradient (#45) --- docs/.vitepress/config.ts | 2 +- docs/.vitepress/sidebar.ts | 4 ++-- docs/core/overview.md | 6 ++++-- docs/index.md | 22 ++++++++++++++++++++++ 4 files changed, 29 insertions(+), 5 deletions(-) diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts index eb364e7..0b09f2d 100644 --- a/docs/.vitepress/config.ts +++ b/docs/.vitepress/config.ts @@ -8,7 +8,7 @@ export default withMermaid({ ignoreDeadLinks: false, lang: 'en-US', lastUpdated: true, - base: '/fedimint-web-sdk/', + // base: '/fedimint-web-sdk/', themeConfig: { // https://vitepress.dev/reference/default-theme-config editLink: { diff --git a/docs/.vitepress/sidebar.ts b/docs/.vitepress/sidebar.ts index 78e3afe..e6697b9 100644 --- a/docs/.vitepress/sidebar.ts +++ b/docs/.vitepress/sidebar.ts @@ -7,8 +7,8 @@ export function getSidebar() { { text: 'Getting Started', items: [ - { text: 'Overview', link: '/core/getting-started' }, - { text: 'Installation', link: '/core/installation' }, + { text: 'Overview', link: '/core/overview' }, + { text: 'Installation', link: '/core/getting-started' }, { text: 'Architecture', link: '/core/architecture' }, ], }, diff --git a/docs/core/overview.md b/docs/core/overview.md index b1d10ef..d830edc 100644 --- a/docs/core/overview.md +++ b/docs/core/overview.md @@ -1,11 +1,13 @@ # @fedimint/core-web -### THIS IS A WORK IN PROGRESS AND NOT READY FOR SERIOUS USE - This package provides a typescript interface for a fedimint client in the browser. It contains the wasm-pack output of the rust-based [fedimint client](https://github.com/fedimint/fedimint/tree/master/fedimint-client-wasm). +::: danger Disclaimer +This is still an unstable work in progress and should not be used for any serious applications. The api's are not settled and may change often. +::: + ## Key Features: - **WebAssembly-powered Client**: Exposes the robust, fault-tolerant fedimint-client (built in Rust) via WebAssembly. Lazy-Loads within a web worker for performance. diff --git a/docs/index.md b/docs/index.md index b9157ed..dbda9af 100644 --- a/docs/index.md +++ b/docs/index.md @@ -45,3 +45,25 @@ features: title: Framework Agnostic details: Designed as a "core" library compatible with vanilla JavaScript, laying the groundwork for future framework-specific packages. --- + +