From 6444e05e02fe3dcbd9edea482997d1b865c49d79 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ma=C3=ABl=20Gangloff?= Date: Tue, 25 Nov 2025 11:20:05 +0100 Subject: [PATCH] docs: update documentation --- docs/src/content/docs/en/acknowledgment.mdx | 1 + docs/src/content/docs/en/definitions/dns.mdx | 2 +- docs/src/content/docs/en/definitions/dnssec.mdx | 4 ++-- .../content/docs/en/definitions/domain-lifecycle.mdx | 4 ++-- docs/src/content/docs/en/definitions/epp.mdx | 6 +++--- docs/src/content/docs/en/definitions/icann.mdx | 4 ++-- docs/src/content/docs/en/definitions/rdap.mdx | 2 +- docs/src/content/docs/en/definitions/registrar.mdx | 4 ++-- docs/src/content/docs/en/definitions/registry.mdx | 2 +- docs/src/content/docs/en/definitions/whois.mdx | 2 +- .../docs/en/developing/implementing-new-provider.mdx | 2 +- .../content/docs/en/features/backorder/connector.mdx | 2 +- docs/src/content/docs/en/features/index.mdx | 10 +++++----- .../docs/en/features/infrastructure/tld-list.mdx | 1 + .../docs/en/features/tracking/tracking-table.mdx | 1 + .../content/docs/en/install-config/configuration.mdx | 2 +- .../docs/en/install-config/install/manual-install.mdx | 2 +- docs/src/content/docs/en/legal/faq.md | 1 + .../content/docs/fr/definitions/domain-lifecycle.mdx | 2 +- docs/src/content/docs/fr/definitions/epp.mdx | 2 +- docs/src/content/docs/fr/definitions/rdap.mdx | 2 +- docs/src/content/docs/fr/definitions/registrar.mdx | 2 +- docs/src/content/docs/fr/definitions/registry.mdx | 2 +- docs/src/content/docs/fr/definitions/whois.mdx | 2 +- .../docs/fr/features/infrastructure/tld-list.mdx | 1 + .../docs/fr/features/tracking/tracking-table.mdx | 1 + 26 files changed, 36 insertions(+), 30 deletions(-) diff --git a/docs/src/content/docs/en/acknowledgment.mdx b/docs/src/content/docs/en/acknowledgment.mdx index 7f59d3c..606f324 100644 --- a/docs/src/content/docs/en/acknowledgment.mdx +++ b/docs/src/content/docs/en/acknowledgment.mdx @@ -1,5 +1,6 @@ --- title: Acknowledgment +description: Many thanks to the contributors to this project, developers and translators. --- import { ContributorList } from "starlight-contributor-list" diff --git a/docs/src/content/docs/en/definitions/dns.mdx b/docs/src/content/docs/en/definitions/dns.mdx index 6f59b5e..59dc69c 100644 --- a/docs/src/content/docs/en/definitions/dns.mdx +++ b/docs/src/content/docs/en/definitions/dns.mdx @@ -30,7 +30,7 @@ When a client requests a domain, the resolution chain queries: + href="/en/definitions/top-level-domain/"/> ## GLUE Records diff --git a/docs/src/content/docs/en/definitions/dnssec.mdx b/docs/src/content/docs/en/definitions/dnssec.mdx index 24e777f..3b431cd 100644 --- a/docs/src/content/docs/en/definitions/dnssec.mdx +++ b/docs/src/content/docs/en/definitions/dnssec.mdx @@ -36,7 +36,7 @@ Implementing DNSSEC involves two main stages: + href="/en/definitions/domain-name/"/> ## The Adoption of DNSSEC @@ -45,7 +45,7 @@ Adoption is a top-down process starting from the Root Zone. While the Root and m + href="/en/definitions/top-level-domain/"/> ## See also diff --git a/docs/src/content/docs/en/definitions/domain-lifecycle.mdx b/docs/src/content/docs/en/definitions/domain-lifecycle.mdx index d82a0fd..078bd99 100644 --- a/docs/src/content/docs/en/definitions/domain-lifecycle.mdx +++ b/docs/src/content/docs/en/definitions/domain-lifecycle.mdx @@ -24,7 +24,7 @@ For most Generic Top-Level Domains (gTLDs) regulated by ICANN, the cycle follows + href="/en/definitions/domain-name/"/> ## Special Cases of some ccTLDs @@ -37,7 +37,7 @@ Country Code Top-Level Domains (ccTLDs) operate under local regulations, leading + href="/en/definitions/top-level-domain/"/> ## See also diff --git a/docs/src/content/docs/en/definitions/epp.mdx b/docs/src/content/docs/en/definitions/epp.mdx index 613b10a..c47f0fc 100644 --- a/docs/src/content/docs/en/definitions/epp.mdx +++ b/docs/src/content/docs/en/definitions/epp.mdx @@ -1,6 +1,6 @@ --- title: EPP Protocol -description: What is a Domain Name Registrar? Learn their role in managing the registration and transfer of domain names for the public. +description: What is the EPP protocol? Learn how this protocol allows registries and registrars to communicate about domain names. --- import {LinkCard} from "@astrojs/starlight/components"; @@ -16,7 +16,7 @@ The Registrar acts as the EPP Client. They send XML commands to create, update, + href="/en/definitions/registrar/"/> ### Server (Registry) @@ -25,7 +25,7 @@ The Registry acts as the EPP Server. It processes the commands, validates logic + href="/en/definitions/registry/"/> ## The Protocol Mechanism diff --git a/docs/src/content/docs/en/definitions/icann.mdx b/docs/src/content/docs/en/definitions/icann.mdx index a6ba62b..cefb0ac 100644 --- a/docs/src/content/docs/en/definitions/icann.mdx +++ b/docs/src/content/docs/en/definitions/icann.mdx @@ -22,7 +22,7 @@ ICANN decides which new Top-Level Domains (TLDs) are added to the Root Zone. + href="/en/definitions/top-level-domain/"/> ## Accrediting Registrars @@ -31,7 +31,7 @@ ICANN manages the accreditation system for Registrars wishing to sell generic TL + href="/en/definitions/registrar/"/> ## See also diff --git a/docs/src/content/docs/en/definitions/rdap.mdx b/docs/src/content/docs/en/definitions/rdap.mdx index f45640c..2d52c30 100644 --- a/docs/src/content/docs/en/definitions/rdap.mdx +++ b/docs/src/content/docs/en/definitions/rdap.mdx @@ -17,7 +17,7 @@ The **Registration Data Access Protocol (RDAP)** is the modern standard for acce + href="/en/definitions/whois/"/> ## Deployment Status diff --git a/docs/src/content/docs/en/definitions/registrar.mdx b/docs/src/content/docs/en/definitions/registrar.mdx index 8885d26..c8faf94 100644 --- a/docs/src/content/docs/en/definitions/registrar.mdx +++ b/docs/src/content/docs/en/definitions/registrar.mdx @@ -10,7 +10,7 @@ A **Registrar** is an accredited commercial entity that sells domain name regist + href="/en/definitions/registry/"/> ## Core Responsibilities @@ -29,7 +29,7 @@ A **Registrar** is an accredited commercial entity that sells domain name regist + href="/en/definitions/dns/"/> ## See also diff --git a/docs/src/content/docs/en/definitions/registry.mdx b/docs/src/content/docs/en/definitions/registry.mdx index 4236e04..b024587 100644 --- a/docs/src/content/docs/en/definitions/registry.mdx +++ b/docs/src/content/docs/en/definitions/registry.mdx @@ -26,7 +26,7 @@ Registries generally do not sell directly to the public. Instead, they: + href="/en/definitions/registrar/"/> ## See also diff --git a/docs/src/content/docs/en/definitions/whois.mdx b/docs/src/content/docs/en/definitions/whois.mdx index f1fc507..77ff5c2 100644 --- a/docs/src/content/docs/en/definitions/whois.mdx +++ b/docs/src/content/docs/en/definitions/whois.mdx @@ -89,7 +89,7 @@ Since the implementation of the **GDPR** (General Data Protection Regulation) an * **Privacy Proxies**: Registrars often provide services that replace the registrant's details with the registrar's generic contact information to prevent spam and harassment. * **Tiered Access**: Full, unredacted data is often no longer publicly available anonymously and requires a legitimate legal request or accreditation. - ## See also diff --git a/docs/src/content/docs/en/developing/implementing-new-provider.mdx b/docs/src/content/docs/en/developing/implementing-new-provider.mdx index 4a5191b..8cd92c6 100644 --- a/docs/src/content/docs/en/developing/implementing-new-provider.mdx +++ b/docs/src/content/docs/en/developing/implementing-new-provider.mdx @@ -21,7 +21,7 @@ You’ll implement both the Backend (Provider logic) and the Frontend (configura 1. Read the API documentation of the new Provider and identify the sections related to user authentication and domain name registration. 1. Set up your development environment. - + ## Backend diff --git a/docs/src/content/docs/en/features/backorder/connector.mdx b/docs/src/content/docs/en/features/backorder/connector.mdx index d78497f..ae25456 100644 --- a/docs/src/content/docs/en/features/backorder/connector.mdx +++ b/docs/src/content/docs/en/features/backorder/connector.mdx @@ -12,7 +12,7 @@ domain registration. 1. Choose an external API provider from the list of supported registrars. - + 2. Enter the required information using the credentials obtained from your provider’s customer area :::tip{icon="heart"} diff --git a/docs/src/content/docs/en/features/index.mdx b/docs/src/content/docs/en/features/index.mdx index 0aacd98..3f8b7d1 100644 --- a/docs/src/content/docs/en/features/index.mdx +++ b/docs/src/content/docs/en/features/index.mdx @@ -43,7 +43,7 @@ To read the documentation related to domain name search, please click on the lin + href="/en/features/search/domain-search/"/> ::: --- @@ -63,7 +63,7 @@ To read the documentation related to the Watchlist, please click on the link bel + href="/en/features/tracking/watchlist/"/> ::: ### Watchlist notifications @@ -84,14 +84,14 @@ To read the documentation related to Connector, please click on the link below. + href="/en/features/backorder/connector/"/> ::: ### Supported registrar list + href="/en/features/backorder/supported-registrar/"/> --- @@ -107,5 +107,5 @@ To read the documentation related to the Tracking table, please click on the lin + href="/en/features/tracking/tracking-table/"/> ::: diff --git a/docs/src/content/docs/en/features/infrastructure/tld-list.mdx b/docs/src/content/docs/en/features/infrastructure/tld-list.mdx index a2e21c2..acbeeba 100644 --- a/docs/src/content/docs/en/features/infrastructure/tld-list.mdx +++ b/docs/src/content/docs/en/features/infrastructure/tld-list.mdx @@ -1,3 +1,4 @@ --- title: TLD list +description: Discover the list of currently active TLDs directly in your interface, along with additional information. --- diff --git a/docs/src/content/docs/en/features/tracking/tracking-table.mdx b/docs/src/content/docs/en/features/tracking/tracking-table.mdx index 7d20e4a..e907543 100644 --- a/docs/src/content/docs/en/features/tracking/tracking-table.mdx +++ b/docs/src/content/docs/en/features/tracking/tracking-table.mdx @@ -1,5 +1,6 @@ --- title: Tracking table +description: The tracking table is a tool that allows you to gather information about the domain names you are tracking. --- ![Tracking table](../../../../../assets/images/tracking-table.png) diff --git a/docs/src/content/docs/en/install-config/configuration.mdx b/docs/src/content/docs/en/install-config/configuration.mdx index 6867b1a..f99b16f 100644 --- a/docs/src/content/docs/en/install-config/configuration.mdx +++ b/docs/src/content/docs/en/install-config/configuration.mdx @@ -5,7 +5,7 @@ description: Configuration guide explaining environment variables and settings r import {LinkCard} from '@astrojs/starlight/components'; - + ## Environment variables diff --git a/docs/src/content/docs/en/install-config/install/manual-install.mdx b/docs/src/content/docs/en/install-config/install/manual-install.mdx index ab0fd60..4fb3d37 100644 --- a/docs/src/content/docs/en/install-config/install/manual-install.mdx +++ b/docs/src/content/docs/en/install-config/install/manual-install.mdx @@ -37,7 +37,7 @@ git clone https://github.com/maelgangloff/domain-watchdog.git ```shell cp .env .env.local ``` - + 3. Generate the cryptographic key pair for the JWT signature ```shell diff --git a/docs/src/content/docs/en/legal/faq.md b/docs/src/content/docs/en/legal/faq.md index d482b7b..b84550d 100644 --- a/docs/src/content/docs/en/legal/faq.md +++ b/docs/src/content/docs/en/legal/faq.md @@ -1,3 +1,4 @@ --- title: FAQ +published: false --- \ No newline at end of file diff --git a/docs/src/content/docs/fr/definitions/domain-lifecycle.mdx b/docs/src/content/docs/fr/definitions/domain-lifecycle.mdx index f5b54c3..059376d 100644 --- a/docs/src/content/docs/fr/definitions/domain-lifecycle.mdx +++ b/docs/src/content/docs/fr/definitions/domain-lifecycle.mdx @@ -1,6 +1,6 @@ --- title: Cycle de vie d'un domaine -description: Explorez le cycle de vie d'un domaine, de l'enregistrement et du renouvellement à l'expiration et la rédemption. Connaissez les phases critiques pour gérer votre nom de domaine. +description: Explorez le cycle de vie d'un domaine, de l'enregistrement et du renouvellement à l'expiration et la rédemption. Découvrez les phases critiques pour gérer votre nom de domaine. --- import {LinkCard} from "@astrojs/starlight/components"; diff --git a/docs/src/content/docs/fr/definitions/epp.mdx b/docs/src/content/docs/fr/definitions/epp.mdx index 09fef0b..cc7dbc9 100644 --- a/docs/src/content/docs/fr/definitions/epp.mdx +++ b/docs/src/content/docs/fr/definitions/epp.mdx @@ -1,6 +1,6 @@ --- title: Protocole EPP -description: Qu'est-ce qu'un bureau d'enregistrement de noms de domaine ? Apprenez leur rôle dans la gestion de l'enregistrement et du transfert des noms de domaine pour le public. +description: Qu'est-ce que le protocole EPP ? Découvrez comment ce protocole permet aux registres et bureaux d'enregistrement de communiquer au sujet des noms de domaines. --- import {LinkCard} from "@astrojs/starlight/components"; diff --git a/docs/src/content/docs/fr/definitions/rdap.mdx b/docs/src/content/docs/fr/definitions/rdap.mdx index 1687c4e..107f094 100644 --- a/docs/src/content/docs/fr/definitions/rdap.mdx +++ b/docs/src/content/docs/fr/definitions/rdap.mdx @@ -1,6 +1,6 @@ --- title: Protocole RDAP -description: Le protocole d'accès aux données moderne. Comprendre RDAP (Registration Data Access Protocol) pour un accès fiable et structuré aux données d'enregistrement et de propriété des domaines. +description: Le protocole moderne d'accès aux informations publiques des domaines. Découvrez RDAP (Registration Data Access Protocol) pour un accès fiable et structuré aux données d'enregistrement et de propriété des domaines. --- import {LinkCard} from "@astrojs/starlight/components"; diff --git a/docs/src/content/docs/fr/definitions/registrar.mdx b/docs/src/content/docs/fr/definitions/registrar.mdx index 276792f..dcaf1be 100644 --- a/docs/src/content/docs/fr/definitions/registrar.mdx +++ b/docs/src/content/docs/fr/definitions/registrar.mdx @@ -1,6 +1,6 @@ --- title: Bureau d'enregistrement -description: Qu'est-ce qu'un bureau d'enregistrement de noms de domaine ? Apprenez leur rôle dans la gestion de l'enregistrement et du transfert des noms de domaine pour le public. +description: Qu'est-ce qu'un bureau d'enregistrement de noms de domaine ? Explorez leur rôle dans la gestion de l'enregistrement et du transfert des noms de domaine pour le public. --- import {LinkCard} from "@astrojs/starlight/components"; diff --git a/docs/src/content/docs/fr/definitions/registry.mdx b/docs/src/content/docs/fr/definitions/registry.mdx index 55594e2..8ffb916 100644 --- a/docs/src/content/docs/fr/definitions/registry.mdx +++ b/docs/src/content/docs/fr/definitions/registry.mdx @@ -1,6 +1,6 @@ --- title: Registre -description: Comprendre le registre de noms de domaine. Apprenez comment ces organisations gèrent la base de données centrale pour tous les noms de domaine sous un TLD spécifique. +description: Qu'est-ce qu'un registre de noms de domaine ? Découvrez comment ces organisations gèrent la base de données centrale pour tous les noms de domaine sous un TLD spécifique. --- import {LinkCard} from "@astrojs/starlight/components"; diff --git a/docs/src/content/docs/fr/definitions/whois.mdx b/docs/src/content/docs/fr/definitions/whois.mdx index 5a5b992..4889dfe 100644 --- a/docs/src/content/docs/fr/definitions/whois.mdx +++ b/docs/src/content/docs/fr/definitions/whois.mdx @@ -1,6 +1,6 @@ --- title: Protocole WHOIS -description: Obtenez un aperçu de WHOIS. Apprenez comment ce protocole est utilisé pour interroger des bases de données afin d'obtenir des informations sur l'utilisateur enregistré ou les attributaires d'un nom de domaine. +description: Qu'est-ce que le protocole WHOIS ? Découvezz comment ce protocole est utilisé pour interroger des bases de données afin d'obtenir des informations sur un nom de domaine. --- import {LinkCard} from "@astrojs/starlight/components"; diff --git a/docs/src/content/docs/fr/features/infrastructure/tld-list.mdx b/docs/src/content/docs/fr/features/infrastructure/tld-list.mdx index dd4c862..715e62b 100644 --- a/docs/src/content/docs/fr/features/infrastructure/tld-list.mdx +++ b/docs/src/content/docs/fr/features/infrastructure/tld-list.mdx @@ -1,3 +1,4 @@ --- title: Liste des TLD +description: Découvrez la liste des TLD actuellement actifs directement dans votre interface, ainsi que des informations complémentaires à leur sujet. --- diff --git a/docs/src/content/docs/fr/features/tracking/tracking-table.mdx b/docs/src/content/docs/fr/features/tracking/tracking-table.mdx index a24f913..5695785 100644 --- a/docs/src/content/docs/fr/features/tracking/tracking-table.mdx +++ b/docs/src/content/docs/fr/features/tracking/tracking-table.mdx @@ -1,5 +1,6 @@ --- title: Tableau de suivi +description: Le tableau de suivi est un outil qui permet de rassembler les informations à propos des noms de domaines que vous suivez. --- ![Tableau de suivi](../../../../../assets/images/tracking-table.png)