From 9cea4e6c77e095eb3ca794cf82dfb60347f4b4b5 Mon Sep 17 00:00:00 2001 From: theborakompanioni Date: Sun, 20 Jul 2025 12:58:43 +0200 Subject: [PATCH] chore: docs github pages --- README.md | 10 ++++----- src/components/App.tsx | 2 +- src/components/Cheatsheet.tsx | 24 ++++++++++++++++++---- src/components/Onboarding.tsx | 7 ++++++- src/components/Settings.tsx | 7 ++++++- src/components/settings/FeeConfigModal.tsx | 2 +- 6 files changed, 39 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 5a1dd078..f42a4a24 100644 --- a/README.md +++ b/README.md @@ -22,8 +22,8 @@ Jam is a web interface for [JoinMarket](https://github.com/JoinMarket-Org/joinmarket-clientserver/) focusing on user-friendliness and ease-of-use. It aims to provide sensible defaults and be easy to use for beginners while still having the features advanced users expect. -- 💬 Join our [Matrix room](https://matrix.to/#/%23jam:bitcoin.kyoto) to get help and [contribute](https://jamdocs.org/contribute/)! -- 📚 Check out the [documentation](https://jamdocs.org) and the [wiki](https://github.com/joinmarket-webui/jam/wiki) for resources such as meeting notes, call recordings, ideas, and discussions. +- 💬 Join our [Matrix room](https://matrix.to/#/%23jam:bitcoin.kyoto) to get help and [contribute](https://joinmarket-webui.github.io/jamdocs/contribute/)! +- 📚 Check out the [documentation](https://joinmarket-webui.github.io/jamdocs/) and the [wiki](https://github.com/joinmarket-webui/jam/wiki) for resources such as meeting notes, call recordings, ideas, and discussions. ## 📸 @@ -61,7 +61,7 @@ If your node system of choice is missing, feel free to integrate it and let us k -Refer to [the installation docs](https://jamdocs.org/software/installation/) for more information on integrations as well as manual installation instructions. +Refer to [the installation docs](https://joinmarket-webui.github.io/jamdocs/software/installation/) for more information on integrations as well as manual installation instructions. ## 🍊 Features @@ -77,9 +77,9 @@ Refer to the [milestones](https://github.com/joinmarket-webui/jam/milestones) fo ## 🧑‍💻 Contribute -This is a [free and open-source](https://jamdocs.org/philosophy/01-free-software/) software project and we love receiving pull-requests, bug reports, ideas, and feedback from everyone. +This is a [free and open-source](https://joinmarket-webui.github.io/jamdocs/philosophy/01-free-software/) software project and we love receiving pull-requests, bug reports, ideas, and feedback from everyone. -There are many ways you can contribute: testing, sharing ideas, writing documentation, creating tutorials, and—of course—writing code. Refer to the [general contribution guidelines](https://jamdocs.org/contribute/) to get started. +There are many ways you can contribute: testing, sharing ideas, writing documentation, creating tutorials, and—of course—writing code. Refer to the [general contribution guidelines](https://joinmarket-webui.github.io/jamdocs/contribute/) to get started. ## 🛠️ Development diff --git a/src/components/App.tsx b/src/components/App.tsx index d8328d08..31b9db2b 100644 --- a/src/components/App.tsx +++ b/src/components/App.tsx @@ -142,7 +142,7 @@ export default function App() { 1: ( diff --git a/src/components/Cheatsheet.tsx b/src/components/Cheatsheet.tsx index f72be287..85c8059c 100644 --- a/src/components/Cheatsheet.tsx +++ b/src/components/Cheatsheet.tsx @@ -50,15 +50,27 @@ export default function Cheatsheet({ show = false, onHide }: CheatsheetProps) {
Follow the steps below to increase your financial privacy. It is advisable to switch from{' '} - + earning as a maker {' '} to{' '} - + sending as a taker {' '} back and forth.{' '} - + Learn more. @@ -115,7 +127,11 @@ export default function Cheatsheet({ show = false, onHide }: CheatsheetProps) {
Still confused?{' '} - + Dig into the documentation . diff --git a/src/components/Onboarding.tsx b/src/components/Onboarding.tsx index 316f9478..be598921 100644 --- a/src/components/Onboarding.tsx +++ b/src/components/Onboarding.tsx @@ -88,7 +88,12 @@ export default function Onboarding() { > Help us improve the project on GitHub. - + read the documentation diff --git a/src/components/Settings.tsx b/src/components/Settings.tsx index 06539730..194fedc7 100644 --- a/src/components/Settings.tsx +++ b/src/components/Settings.tsx @@ -253,7 +253,12 @@ export default function Settings({ wallet, stopWallet }: SettingsProps) {
{t('settings.section_title_dev')}
- +
{t('settings.documentation')} diff --git a/src/components/settings/FeeConfigModal.tsx b/src/components/settings/FeeConfigModal.tsx index 89f7875e..c52ad76c 100644 --- a/src/components/settings/FeeConfigModal.tsx +++ b/src/components/settings/FeeConfigModal.tsx @@ -452,7 +452,7 @@ export default function FeeConfigModal({ Fee description. See