docs: update documentation

This commit is contained in:
Maël Gangloff 2025-11-14 17:20:34 +01:00
parent e040f484c9
commit 4f35d9f8b5
No known key found for this signature in database
GPG Key ID: 11FDC81C24A7F629
4 changed files with 93 additions and 75 deletions

View File

@ -2,26 +2,24 @@
title: Connector title: Connector
--- ---
import {LinkCard} from '@astrojs/starlight/components'; import {LinkCard, Steps} from '@astrojs/starlight/components';
A Connector allows Domain Watchdog to communicate with an external domain registrars API to perform actions such as A Connector allows Domain Watchdog to communicate with an external domain registrars API to perform actions such as
domain registration. domain registration.
## Create a Connector ## Create a Connector
<Steps>
1. Choose an external API provider from the list of supported registrars. 1. Choose an external API provider from the list of supported registrars.
<LinkCard title="Supported registrar" description="List of supported registrars for creating a Connector" href="../supported-registrar"/> <LinkCard title="Supported registrar" description="List of supported registrars for creating a Connector" href="../supported-registrar"/>
2. Enter the required information using the credentials obtained from your providers customer area 2. Enter the required information using the credentials obtained from your providers customer area
:::tip{icon="heart"} :::tip{icon="heart"}
A link allows you to directly access the Provider's page to retrieve this authentication information A link allows you to directly access the Provider's page to retrieve this authentication information
::: :::
3. Review and consent to the required terms. As a reminder, you can delete a Connector at any time from your personal 3. Review and consent to the required terms. As a reminder, you can delete a Connector at any time from your personal
space. space.
4. Click the button to create your Connector. **Congratulations 🎉** 4. Click the button to create your Connector. **Congratulations 🎉**
</Steps>
## Legal considerations ## Legal considerations

View File

@ -3,7 +3,7 @@ title: Getting started
description: Step-by-step guide to creating an account, searching domains, tracking changes, and enabling auto-purchase with Connectors. description: Step-by-step guide to creating an account, searching domains, tracking changes, and enabling auto-purchase with Connectors.
--- ---
import {LinkCard} from '@astrojs/starlight/components'; import {LinkCard, Steps} from '@astrojs/starlight/components';
On this page, you'll find a step-by-step guide to getting started with **Domain Watchdog** and exploring its main On this page, you'll find a step-by-step guide to getting started with **Domain Watchdog** and exploring its main
features. The sidebar menu on the left allows you to quickly navigate between all documentation sections. features. The sidebar menu on the left allows you to quickly navigate between all documentation sections.
@ -21,9 +21,11 @@ If your instance allows user registration, you can create an account directly fr
![User registration](../../../../assets/images/user-register.png) ![User registration](../../../../assets/images/user-register.png)
<Steps>
1. Click the **Register** button. 1. Click the **Register** button.
2. Enter your **email address** and **password**. 2. Enter your **email address** and **password**.
3. A confirmation email will be sent to verify your address. 3. A confirmation email will be sent to verify your address.
</Steps>
After confirming your email, you can log in and start using all available features. After confirming your email, you can log in and start using all available features.
@ -36,11 +38,13 @@ domain names.
![Search for a domain name](../../../../assets/images/search-domain.png) ![Search for a domain name](../../../../assets/images/search-domain.png)
:::tip[Read more]
To read the documentation related to domain name search, please click on the link below. To read the documentation related to domain name search, please click on the link below.
<LinkCard title="Domain search" <LinkCard title="Domain search"
description="Obtain the details of a domain name registration and the history of observed events" description="Obtain the details of a domain name registration and the history of observed events"
href="../features/search/domain-search"/> href="../features/search/domain-search"/>
:::
--- ---
@ -48,17 +52,19 @@ To read the documentation related to domain name search, please click on the lin
A **Watchlist** is a collection of domain names, triggers, and optionally an API Connector. A **Watchlist** is a collection of domain names, triggers, and optionally an API Connector.
It allows you to: It allows you to:
- monitor domain status changes, - monitor domain status changes
- receive notifications (email or webhook: Slack, Mattermost, Discord, etc.), - receive notifications (email or webhook: Slack, Mattermost, Discord, etc.)
- optionally auto-purchase a domain when it expires. - optionally auto-purchase a domain when it expires
![Create a Watchlist](../../../../assets/images/create-watchlist.png) ![Create a Watchlist](../../../../assets/images/create-watchlist.png)
:::tip[Read more]
To read the documentation related to the Watchlist, please click on the link below. To read the documentation related to the Watchlist, please click on the link below.
<LinkCard title="Watchlist" <LinkCard title="Watchlist"
description="Add domain names to a Watchlist to track them, be notified of any changes, and potentially buy them when they expire" description="Add domain names to a Watchlist to track them, be notified of any changes, and potentially buy them when they expire"
href="../features/tracking/watchlist"/> href="../features/tracking/watchlist"/>
:::
### Watchlist notifications ### Watchlist notifications
@ -73,11 +79,13 @@ A **Connector** is used to automatically order (backorder) a domain name using i
![Create a Connector](../../../../assets/images/create-connector.png) ![Create a Connector](../../../../assets/images/create-connector.png)
:::tip[Read more]
To read the documentation related to Connector, please click on the link below. To read the documentation related to Connector, please click on the link below.
<LinkCard title="Connector" <LinkCard title="Connector"
description="Create a Connector to enable domain name purchases by linking it to your Watchlists" description="Create a Connector to enable domain name purchases by linking it to your Watchlists"
href="../features/backorder/connector"/> href="../features/backorder/connector"/>
:::
### Supported registrar list ### Supported registrar list
@ -94,8 +102,10 @@ This list is ordered, meaning the domain names are arranged according to their e
![Tracking table](../../../../assets/images/tracking-table.png) ![Tracking table](../../../../assets/images/tracking-table.png)
:::tip[Read more]
To read the documentation related to the Tracking table, please click on the link below. To read the documentation related to the Tracking table, please click on the link below.
<LinkCard title="Tracking table" <LinkCard title="Tracking table"
description="List all the domains you're monitoring in your Watchlist and track the status of those domains" description="List all the domains you're monitoring in your Watchlist and track the status of those domains"
href="../features/tracking/tracking-table"/> href="../features/tracking/tracking-table"/>
:::

View File

@ -1,6 +1,7 @@
--- ---
title: Watchlist title: Watchlist
--- ---
import {Steps} from '@astrojs/starlight/components';
A Watchlist is a list of domain names, triggers and possibly an API connector. They allow you to follow the life of the A Watchlist is a list of domain names, triggers and possibly an API connector. They allow you to follow the life of the
listed domain names and send you a notification when a change has been detected. listed domain names and send you a notification when a change has been detected.
@ -15,11 +16,13 @@ possible to predict in advance which user will win the domain name. The choice i
## Create a Watchlist ## Create a Watchlist
<Steps>
1. Choose a name for your Watchlist and find it more easily 1. Choose a name for your Watchlist and find it more easily
2. Add the domain names you want to follow 2. Add the domain names you want to follow
3. Select the events for which you want to receive an email notification 3. Select the events for which you want to receive an email notification
4. Optionally add a connector to try to automatically buy a domain name that becomes available 4. Optionally add a connector to try to automatically buy a domain name that becomes available
5. Click the button to create your Watchlist. **Congratulations 🎉** 5. Click the button to create your Watchlist. **Congratulations 🎉**
</Steps>
Now, it's your turn to create a Watchlist! Now, it's your turn to create a Watchlist!

View File

@ -2,7 +2,7 @@
title: Manual Install title: Manual Install
--- ---
import {LinkCard} from '@astrojs/starlight/components'; import {LinkCard, Steps} from '@astrojs/starlight/components';
## Installation ## Installation
@ -29,6 +29,7 @@ git clone https://github.com/maelgangloff/domain-watchdog.git
#### Backend #### Backend
<Steps>
1. Install dependencies: 1. Install dependencies:
```shell ```shell
composer install composer install
@ -37,7 +38,6 @@ composer install
```shell ```shell
cp .env .env.local cp .env .env.local
``` ```
<LinkCard title="Configuration" description="List of environment variables" href="../configuration"/> <LinkCard title="Configuration" description="List of environment variables" href="../configuration"/>
3. Generate the cryptographic key pair for the JWT signature 3. Generate the cryptographic key pair for the JWT signature
@ -57,9 +57,11 @@ symfony server:start
php bin/console assets:install php bin/console assets:install
``` ```
7. Don't forget to set up workers to process the [message queue](https://symfony.com/doc/current/messenger.html) 7. Don't forget to set up workers to process the [message queue](https://symfony.com/doc/current/messenger.html)
</Steps>
#### Frontend #### Frontend
<Steps>
1. Install dependencies: 1. Install dependencies:
```shell ```shell
yarn install yarn install
@ -82,6 +84,7 @@ public/images/icons-512.png
public/images/banner.png public/images/banner.png
public/favicon.ico public/favicon.ico
~~~ ~~~
</Steps>
## Update ## Update
@ -95,6 +98,7 @@ git pull origin master
### Backend ### Backend
<Steps>
1. Install dependencies: 1. Install dependencies:
```shell ```shell
composer install composer install
@ -111,9 +115,11 @@ php bin/console cache:clear
```shell ```shell
php bin/console assets:install php bin/console assets:install
``` ```
</Steps>
### Frontend ### Frontend
<Steps>
1. Install dependencies: 1. Install dependencies:
```shell ```shell
yarn install yarn install
@ -126,3 +132,4 @@ yarn run ttag:po2json
```shell ```shell
yarn build yarn build
``` ```
</Steps>