diff --git a/docs/src/assets/images/create-connector.png b/docs/src/assets/images/create-connector.png new file mode 100644 index 0000000..42fcd44 Binary files /dev/null and b/docs/src/assets/images/create-connector.png differ diff --git a/docs/src/assets/images/create-watchlist.png b/docs/src/assets/images/create-watchlist.png new file mode 100644 index 0000000..940e008 Binary files /dev/null and b/docs/src/assets/images/create-watchlist.png differ diff --git a/docs/src/assets/images/search-domain.png b/docs/src/assets/images/search-domain.png new file mode 100644 index 0000000..0f75cff Binary files /dev/null and b/docs/src/assets/images/search-domain.png differ diff --git a/docs/src/assets/images/tracking-table.png b/docs/src/assets/images/tracking-table.png new file mode 100644 index 0000000..33ebf16 Binary files /dev/null and b/docs/src/assets/images/tracking-table.png differ diff --git a/docs/src/assets/images/user-register.png b/docs/src/assets/images/user-register.png new file mode 100644 index 0000000..ae948e5 Binary files /dev/null and b/docs/src/assets/images/user-register.png differ diff --git a/docs/src/content/docs/en/features/backorder/supported-registrar.mdx b/docs/src/content/docs/en/features/backorder/supported-registrar.mdx index cb205e0..bb00035 100644 --- a/docs/src/content/docs/en/features/backorder/supported-registrar.mdx +++ b/docs/src/content/docs/en/features/backorder/supported-registrar.mdx @@ -1,5 +1,5 @@ --- -title: Supported registrar +title: Supported registrar list --- import {LinkButton} from '@astrojs/starlight/components'; diff --git a/docs/src/content/docs/en/features/index.md b/docs/src/content/docs/en/features/index.md deleted file mode 100644 index 805df41..0000000 --- a/docs/src/content/docs/en/features/index.md +++ /dev/null @@ -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 diff --git a/docs/src/content/docs/en/features/index.mdx b/docs/src/content/docs/en/features/index.mdx new file mode 100644 index 0000000..9d9d92c --- /dev/null +++ b/docs/src/content/docs/en/features/index.mdx @@ -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. + +![User registration](../../../../assets/images/user-register.png) + +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. + +![Search for a domain name](../../../../assets/images/search-domain.png) + +To read the documentation related to domain name search, please click on the link below. + + + +--- + +## 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. + +![Create a Watchlist](../../../../assets/images/create-watchlist.png) + +To read the documentation related to the Watchlist, please click on the link below. + + + +### 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. + +![Create a Connector](../../../../assets/images/create-connector.png) + +To read the documentation related to Connector, please click on the link below. + + + +### Supported registrar list + + + +--- + +### 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. + +![Tracking table](../../../../assets/images/tracking-table.png) + +To read the documentation related to the Tracking table, please click on the link below. + +