chore: docs github pages

This commit is contained in:
theborakompanioni 2025-07-20 12:58:43 +02:00
parent 92bf282aa7
commit 9cea4e6c77
No known key found for this signature in database
GPG key ID: E8070AF0053AAC0D
6 changed files with 39 additions and 13 deletions

View file

@ -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
</tbody>
</table>
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

View file

@ -142,7 +142,7 @@ export default function App() {
1: (
<a
className="alert-link"
href="https://jamdocs.org/FAQ/#how-to-resolve-no-connection-to-gateway"
href="https://joinmarket-webui.github.io/jamdocs/FAQ/#how-to-resolve-no-connection-to-gateway"
target="_blank"
rel="noopener noreferrer"
>

View file

@ -50,15 +50,27 @@ export default function Cheatsheet({ show = false, onHide }: CheatsheetProps) {
<div className="small text-secondary">
<Trans i18nKey="cheatsheet.description">
Follow the steps below to increase your financial privacy. It is advisable to switch from{' '}
<a href="https://jamdocs.org/glossary/#maker" target="_blank" rel="noopener noreferrer">
<a
href="https://joinmarket-webui.github.io/jamdocs/glossary/#maker"
target="_blank"
rel="noopener noreferrer"
>
earning as a maker
</a>{' '}
to{' '}
<a href="https://jamdocs.org/glossary/#taker" target="_blank" rel="noopener noreferrer">
<a
href="https://joinmarket-webui.github.io/jamdocs/glossary/#taker"
target="_blank"
rel="noopener noreferrer"
>
sending as a taker
</a>{' '}
back and forth.{' '}
<a href="https://jamdocs.org/interface/00-cheatsheet/" target="_blank" rel="noopener noreferrer">
<a
href="https://joinmarket-webui.github.io/jamdocs/interface/00-cheatsheet/"
target="_blank"
rel="noopener noreferrer"
>
Learn more.
</a>
</Trans>
@ -115,7 +127,11 @@ export default function Cheatsheet({ show = false, onHide }: CheatsheetProps) {
<div className="small text-secondary">
<Trans i18nKey="cheatsheet.repeat.description">
Still confused?{' '}
<a href="https://jamdocs.org/interface/00-cheatsheet/" target="_blank" rel="noopener noreferrer">
<a
href="https://joinmarket-webui.github.io/jamdocs/interface/00-cheatsheet/"
target="_blank"
rel="noopener noreferrer"
>
Dig into the documentation
</a>
.

View file

@ -88,7 +88,12 @@ export default function Onboarding() {
>
Help us improve the project on GitHub.
</a>
<a href="https://jamdocs.org" target="_blank" rel="noopener noreferrer" className="link-secondary">
<a
href="https://joinmarket-webui.github.io/jamdocs/"
target="_blank"
rel="noopener noreferrer"
className="link-secondary"
>
read the documentation
</a>
</Trans>

View file

@ -253,7 +253,12 @@ export default function Settings({ wallet, stopWallet }: SettingsProps) {
</div>
<div className={styles['section-title']}>{t('settings.section_title_dev')}</div>
<div className={styles['settings-links']}>
<a href="https://jamdocs.org" target="_blank" rel="noopener noreferrer" className="link-dark">
<a
href="https://joinmarket-webui.github.io/jamdocs/"
target="_blank"
rel="noopener noreferrer"
className="link-dark"
>
<div className="d-flex align-items-center">
<Sprite symbol="file" width="24" height="24" className="me-2" />
{t('settings.documentation')}

View file

@ -452,7 +452,7 @@ export default function FeeConfigModal({
<Trans i18nKey="settings.fees.description">
Fee description. See
<a
href="https://jamdocs.org/market/fees/"
href="https://joinmarket-webui.github.io/jamdocs/market/fees/"
target="_blank"
rel="noopener noreferrer"
className="link-dark"