mirror of
https://github.com/maelgangloff/domain-watchdog.git
synced 2025-12-29 16:15:04 +00:00
docs: update documentation
This commit is contained in:
BIN
docs/src/assets/images/create-connector.png
Normal file
BIN
docs/src/assets/images/create-connector.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 50 KiB |
BIN
docs/src/assets/images/create-watchlist.png
Normal file
BIN
docs/src/assets/images/create-watchlist.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 53 KiB |
BIN
docs/src/assets/images/search-domain.png
Normal file
BIN
docs/src/assets/images/search-domain.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 92 KiB |
BIN
docs/src/assets/images/tracking-table.png
Normal file
BIN
docs/src/assets/images/tracking-table.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 49 KiB |
BIN
docs/src/assets/images/user-register.png
Normal file
BIN
docs/src/assets/images/user-register.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 11 KiB |
@@ -1,5 +1,5 @@
|
||||
---
|
||||
title: Supported registrar
|
||||
title: Supported registrar list
|
||||
---
|
||||
|
||||
import {LinkButton} from '@astrojs/starlight/components';
|
||||
|
||||
@@ -1,24 +0,0 @@
|
||||
---
|
||||
title: Getting started
|
||||
---
|
||||
|
||||
On this page, you'll find a step-by-step guide to getting started with Domain Watchdog and exploring its features.
|
||||
|
||||
:::note
|
||||
Depending on the configuration of the instance on which you're performing these actions, your options may be
|
||||
limited.
|
||||
:::
|
||||
|
||||
The sidebar menu on the left allows you to quickly navigate between the pages, which are described below.
|
||||
|
||||
## Create an account
|
||||
|
||||
If your configuration allows, you can create an account directly in the interface. First, click the registration button
|
||||
and enter an email address and password.
|
||||
A confirmation email will be sent to you to verify your email address.
|
||||
|
||||
## Search for a domain name
|
||||
|
||||
## Create a Watchlist
|
||||
|
||||
## Create a Connector
|
||||
101
docs/src/content/docs/en/features/index.mdx
Normal file
101
docs/src/content/docs/en/features/index.mdx
Normal file
@@ -0,0 +1,101 @@
|
||||
---
|
||||
title: Getting started
|
||||
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';
|
||||
|
||||
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.
|
||||
|
||||
:::note
|
||||
Depending on the configuration of the instance on which you're performing these actions, some options may be limited or
|
||||
hidden.
|
||||
:::
|
||||
|
||||
---
|
||||
|
||||
## Create an account
|
||||
|
||||
If your instance allows user registration, you can create an account directly from the interface.
|
||||
|
||||

|
||||
|
||||
1. Click the **Register** button.
|
||||
2. Enter your **email address** and **password**.
|
||||
3. A confirmation email will be sent to verify your address.
|
||||
|
||||
After confirming your email, you can log in and start using all available features.
|
||||
|
||||
---
|
||||
|
||||
## Search for a domain name
|
||||
|
||||
Domain Watchdog uses the **RDAP protocol**, the modern replacement for WHOIS, to retrieve accurate information about
|
||||
domain names.
|
||||
|
||||

|
||||
|
||||
To read the documentation related to domain name search, please click on the link below.
|
||||
|
||||
<LinkCard title="Domain search"
|
||||
description="Obtain the details of a domain name registration and the history of observed events"
|
||||
href="../features/search/domain-search"/>
|
||||
|
||||
---
|
||||
|
||||
## Create a Watchlist
|
||||
|
||||
A **Watchlist** is a collection of domain names, triggers, and optionally an API Connector.
|
||||
It allows you to:
|
||||
- monitor domain status changes,
|
||||
- receive notifications (email or webhook: Slack, Mattermost, Discord, etc.),
|
||||
- optionally auto-purchase a domain when it expires.
|
||||
|
||||

|
||||
|
||||
To read the documentation related to the Watchlist, please click on the link below.
|
||||
|
||||
<LinkCard title="Watchlist"
|
||||
description="Add domain names to aWatchlist to track them, be notified of any changes, and potentially buy them when they expire"
|
||||
href="../features/tracking/watchlist"/>
|
||||
|
||||
### Watchlist notifications
|
||||
|
||||
When a domain changes state, you’ll automatically receive a notification.
|
||||
You can also export domain events as **iCalendar** feeds.
|
||||
|
||||
---
|
||||
|
||||
## Create a Connector
|
||||
|
||||
A **Connector** is used to automatically order (backorder) a domain name using its provider’s API.
|
||||
|
||||

|
||||
|
||||
To read the documentation related to Connector, please click on the link below.
|
||||
|
||||
<LinkCard title="Connector"
|
||||
description="Create a Connector to enable domain name purchases by linking it to your Watchlists"
|
||||
href="../features/backorder/connector"/>
|
||||
|
||||
### Supported registrar list
|
||||
|
||||
<LinkCard title="Supported registrar list"
|
||||
description="List of registrars supported by this project"
|
||||
href="../features/backorder/supported-registrar"/>
|
||||
|
||||
---
|
||||
|
||||
### Tracking table
|
||||
|
||||
The Tracking table page displays a list of all the domain names you monitor via your Watchlists.
|
||||
This list is ordered, meaning the domain names are arranged according to their estimated deletion date.
|
||||
|
||||

|
||||
|
||||
To read the documentation related to the Tracking table, please click on the link below.
|
||||
|
||||
<LinkCard title="Tracking table"
|
||||
description="List all the domains you're monitoring in your Watchlist and track the status of those domains"
|
||||
href="../features/tracking/tracking-table"/>
|
||||
Reference in New Issue
Block a user