diff --git a/docs/astro.config.mjs b/docs/astro.config.mjs index d2de2de..3fad8a8 100644 --- a/docs/astro.config.mjs +++ b/docs/astro.config.mjs @@ -4,6 +4,7 @@ import starlight from '@astrojs/starlight' import starlightLinksValidator from 'starlight-links-validator' import mermaid from "astro-mermaid" import starlightCoolerCredit from "starlight-cooler-credit" +import starlightKbd from 'starlight-kbd' const BASE_URL = 'https://domainwatchdog.eu' @@ -24,7 +25,10 @@ export default defineConfig({ }, tagline: 'Your companion in the quest for domain names 🔍', lastUpdated: true, - social: [{icon: 'github', label: 'GitHub', href: 'https://github.com/maelgangloff/domain-watchdog'}], + social: [ + {icon: 'github', label: 'GitHub', href: 'https://github.com/maelgangloff/domain-watchdog'}, + {icon: 'seti:docker', label: 'Docker', href: 'https://hub.docker.com/r/maelgangloff/domain-watchdog'} + ], sidebar: [ {label: 'Getting started', slug: 'features'}, { @@ -38,9 +42,10 @@ export default defineConfig({ { label: 'Features', items: [ + {slug: 'features/search/domain-search'}, {label: 'Domain back-order', autogenerate: {directory: 'features/backorder'}}, - {label: 'Domain search', autogenerate: {directory: 'features/search'}}, {label: 'Domain tracking', autogenerate: {directory: 'features/tracking'}}, + {label: 'Infrastructure', autogenerate: {directory: 'features/infrastructure'}}, ] }, { @@ -124,7 +129,13 @@ _paq.push(['enableHeartBeatTimer']); description: 'Maintained with ♡ by Maël Gangloff & contributors' }, showImage: false - }) + }), + starlightKbd({ + types: [ + {id: 'mac', label: 'macOS', default: true}, + {id: 'windows', label: 'Windows'}, + ], + }), ], customCss: [ './src/styles/index.css' diff --git a/docs/package.json b/docs/package.json index 246445d..78600d6 100644 --- a/docs/package.json +++ b/docs/package.json @@ -23,6 +23,7 @@ "sharp": "^0.34.2", "starlight-contributor-list": "^0.3.1", "starlight-cooler-credit": "^0.4.1", + "starlight-kbd": "^0.2.1", "starlight-links-validator": "^0.19.1" } } diff --git a/docs/src/content/docs/en/developing/translation.mdx b/docs/src/content/docs/en/developing/translation.mdx index 06ee323..821d18b 100644 --- a/docs/src/content/docs/en/developing/translation.mdx +++ b/docs/src/content/docs/en/developing/translation.mdx @@ -4,10 +4,13 @@ description: This project is available in several languages, the current transla --- The project is translated into several languages to allow as many people as possible to easily understand the interface. -Feel free to contribute and add a translation if you wish! +Feel free to contribute and add a translation! The current status of the translation is given below. - -Translation status - \ No newline at end of file +[![Translation status](https://weblate.vinceh121.me/widget/domain-watchdog/domain-watchdog-dashboard/open-graph.png)](https://weblate.vinceh121.me/engage/domain-watchdog/) + + +If you don't find your language in the list above, feel free to open an issue on the project repository and request that a new language be added. + +Once the language is added, you can start suggesting translations in the translation space. This project uses Weblate for community translation. diff --git a/docs/src/content/docs/en/features/backorder/connector.mdx b/docs/src/content/docs/en/features/backorder/connector.mdx index 8cce9cb..d78497f 100644 --- a/docs/src/content/docs/en/features/backorder/connector.mdx +++ b/docs/src/content/docs/en/features/backorder/connector.mdx @@ -13,12 +13,14 @@ 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"} 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 -space. + +3. Review and consent to the required terms. As a reminder, you can delete a Connector at any time from your personal space. + 4. Click the button to create your Connector. **Congratulations 🎉** diff --git a/docs/src/content/docs/en/features/search/icann-registrar-list.mdx b/docs/src/content/docs/en/features/infrastructure/icann-registrar-list.mdx similarity index 97% rename from docs/src/content/docs/en/features/search/icann-registrar-list.mdx rename to docs/src/content/docs/en/features/infrastructure/icann-registrar-list.mdx index 1caa289..ba00591 100644 --- a/docs/src/content/docs/en/features/search/icann-registrar-list.mdx +++ b/docs/src/content/docs/en/features/infrastructure/icann-registrar-list.mdx @@ -1,3 +1,4 @@ --- title: ICANN Registrar list --- + diff --git a/docs/src/content/docs/en/features/search/tld-list.mdx b/docs/src/content/docs/en/features/infrastructure/tld-list.mdx similarity index 100% rename from docs/src/content/docs/en/features/search/tld-list.mdx rename to docs/src/content/docs/en/features/infrastructure/tld-list.mdx diff --git a/docs/src/content/docs/en/features/search/domain-search.mdx b/docs/src/content/docs/en/features/search/domain-search.mdx index 77fd0bd..8db8ad1 100644 --- a/docs/src/content/docs/en/features/search/domain-search.mdx +++ b/docs/src/content/docs/en/features/search/domain-search.mdx @@ -3,8 +3,32 @@ title: Domain search description: Domain search feature overview --- +import {Steps} from "@astrojs/starlight/components" +import {Kbd} from "starlight-kbd/components" + :::tip[Did you know?] -In this project, everything is done to minimize the number of requests to RDAP servers. Limitations imposed on end users -help to control the flow of RDAP requests. These limitations can be configured for each instance, in the environment -variables. +In this project, everything is done to minimize the number of requests to RDAP servers. Limitations imposed on end users help control the flow of RDAP requests. +These limitations can be configured for each instance, in the environment variables. ::: + +The domain search feature allows users to look up information about a domain name through the user interface. + +To search for a domain name: + + + 1. Enter the domain in the search bar. + 2. Press to submit the query. + + +![Search for a domain name](../../../../../assets/images/search-domain.png) + +If the extension you are searching for does **not** have an official RDAP server, an error message will inform you that no RDAP server is available. + +## Force Update + +By default, if the domain information stored in the database is still considered valid, the system returns the existing record without performing a new RDAP query. + +If you need to force an RDAP update for a given domain: +* Press when submitting the search. + +This triggers a fresh lookup against the RDAP server. 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 9fd5ea3..7d20e4a 100644 --- a/docs/src/content/docs/en/features/tracking/tracking-table.mdx +++ b/docs/src/content/docs/en/features/tracking/tracking-table.mdx @@ -1,3 +1,5 @@ --- title: Tracking table ---- \ No newline at end of file +--- + +![Tracking table](../../../../../assets/images/tracking-table.png) diff --git a/docs/src/content/docs/en/features/tracking/watchlist.mdx b/docs/src/content/docs/en/features/tracking/watchlist.mdx index 547f46a..29d0026 100644 --- a/docs/src/content/docs/en/features/tracking/watchlist.mdx +++ b/docs/src/content/docs/en/features/tracking/watchlist.mdx @@ -17,6 +17,8 @@ possible to predict in advance which user will win the domain name. The choice i ## Create a Watchlist +![Create a Watchlist](../../../..//../assets/images/create-watchlist.png) + 1. Choose a name for your Watchlist and find it more easily 2. Add the domain names you want to follow diff --git a/docs/yarn.lock b/docs/yarn.lock index 1e305a5..05e972f 100644 --- a/docs/yarn.lock +++ b/docs/yarn.lock @@ -4086,6 +4086,11 @@ starlight-cooler-credit@^0.4.1: dependencies: change-case "^5.4.4" +starlight-kbd@^0.2.1: + version "0.2.1" + resolved "https://registry.yarnpkg.com/starlight-kbd/-/starlight-kbd-0.2.1.tgz#3656c23205d07b2c62902c4af6136e743deb571b" + integrity sha512-kFDWkB99GSk1korUrHezRxcjLhQ53axDyI9oZakEPB5ZNU3b+uwp2kVMhEg6B5yzekwFgf84UlNiWu9lYpfMoA== + starlight-links-validator@^0.19.1: version "0.19.1" resolved "https://registry.yarnpkg.com/starlight-links-validator/-/starlight-links-validator-0.19.1.tgz#7c3c2f25e988104627c563ffbd27e523735200f1"