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:
Maël Gangloff
@@ -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'
|
||||
|
||||
@@ -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"
|
||||
}
|
||||
}
|
||||
|
||||
@@ -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.
|
||||
|
||||
<a href="https://weblate.vinceh121.me/engage/domain-watchdog/">
|
||||
<img src="https://weblate.vinceh121.me/widget/domain-watchdog/domain-watchdog-dashboard/open-graph.png" alt="Translation status" />
|
||||
</a>
|
||||
[](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.
|
||||
|
||||
@@ -13,12 +13,14 @@ domain registration.
|
||||
<Steps>
|
||||
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="/en/features/backorder/supported-registrar"/>
|
||||
|
||||
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 🎉**
|
||||
</Steps>
|
||||
|
||||
|
||||
@@ -1,3 +1,4 @@
|
||||
---
|
||||
title: ICANN Registrar list
|
||||
---
|
||||
|
||||
@@ -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:
|
||||
|
||||
<Steps>
|
||||
1. Enter the domain in the search bar.
|
||||
2. Press <Kbd mac="Enter" windows="Enter" /> to submit the query.
|
||||
</Steps>
|
||||
|
||||
|
||||
|
||||
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 <Kbd mac="Shift+Enter" windows="Shift+Enter" /> when submitting the search.
|
||||
|
||||
This triggers a fresh lookup against the RDAP server.
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
---
|
||||
title: Tracking table
|
||||
---
|
||||
---
|
||||
|
||||
|
||||
|
||||
@@ -17,6 +17,8 @@ possible to predict in advance which user will win the domain name. The choice i
|
||||
|
||||
## Create a Watchlist
|
||||
|
||||
|
||||
|
||||
<Steps>
|
||||
1. Choose a name for your Watchlist and find it more easily
|
||||
2. Add the domain names you want to follow
|
||||
|
||||
@@ -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"
|
||||
|
||||
Reference in New Issue
Block a user