From f2b5e0d73219dab9cb35e67b4c40204c8ecf05bb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ma=C3=ABl=20Gangloff?= Date: Thu, 4 Dec 2025 16:06:09 +0100 Subject: [PATCH] docs: update documentation --- docs/astro.config.mjs | 9 ++- docs/src/components/testimonial.astro | 90 +++++++++++++++++++++ docs/src/content/docs/en/acknowledgment.mdx | 84 +++++++++++++++++-- docs/src/content/docs/en/legal/license.md | 4 +- docs/tsconfig.json | 19 ++++- 5 files changed, 193 insertions(+), 13 deletions(-) create mode 100644 docs/src/components/testimonial.astro diff --git a/docs/astro.config.mjs b/docs/astro.config.mjs index 8e9e275..ae668bc 100644 --- a/docs/astro.config.mjs +++ b/docs/astro.config.mjs @@ -90,10 +90,11 @@ export default defineConfig({ }, { tag: 'meta', - attrs: { - name: 'author', - content: 'Maël Gangloff' - }, + attrs: {name: 'author', content: 'Maël Gangloff'}, + }, + { + tag: 'meta', + attrs: {name: 'theme-color', content: '#475569'} }, { tag: 'meta', diff --git a/docs/src/components/testimonial.astro b/docs/src/components/testimonial.astro new file mode 100644 index 0000000..f01e09e --- /dev/null +++ b/docs/src/components/testimonial.astro @@ -0,0 +1,90 @@ +--- +import {Image} from 'astro:assets' + +interface Props { + username: string + name: string + cite: string +} + +const {name, username, cite} = Astro.props +--- + +
  • +
    + +
    +
    + +
    +

    {name}

    + @{username} +
    +
    +
    • + + \ No newline at end of file diff --git a/docs/src/content/docs/en/acknowledgment.mdx b/docs/src/content/docs/en/acknowledgment.mdx index f2490ae..bc3c949 100644 --- a/docs/src/content/docs/en/acknowledgment.mdx +++ b/docs/src/content/docs/en/acknowledgment.mdx @@ -1,14 +1,88 @@ --- -title: 🙌 Acknowledgment -description: Many thanks to the contributors to this project, the developers and the translators, without whom this project could not exist. +title: 🙌 Acknowledgments +description: Many thanks to the contributors, developers, and translators whose work makes this project possible. --- import { ContributorList } from "starlight-contributor-list" +import { LinkCard} from "@astrojs/starlight/components"; +import Testimonial from '~/components/testimonial.astro' ## Contributors -A huge thank-you to everyone who has contributed to this project! -Your ideas, bug reports, code improvements, and translations all help make this project better for everyone. - +Thank you to all the individuals who help improve this project. +Your reports, discussions, code contributions, documentation efforts, and translations collectively enhance its quality, reliability, and accessibility. + +## Maintainer + + + + +## Dependencies + +This project is built upon a variety of open-source tools and libraries. +These dependencies enable essential features such as domain lookups, data storage, notifications, API handling, and more. + +To learn more about the technologies used and the architectural decisions behind the project, visit: + + + +## External Data Sources + +Domain Watchdog integrates several publicly available datasets and standardized resources. +These external inputs ensure accurate domain information, consistent behavior across TLDs, and reliable monitoring. + +### IANA + +The project relies on IANA’s published datasets, including: + +- the [complete list of Top-Level Domains (TLDs)](https://data.iana.org/TLD/tlds-alpha-by-domain.txt), +- the [official list of accredited domain registrars](https://www.iana.org/assignments/registrar-ids/registrar-ids.xhtml), +- registrar IANA identification numbers and their declared RDAP endpoints. + +These resources provide the foundation for consistent and up-to-date domain lookups. + +### ICANN + +ICANN’s [RDAP bootstrap file](https://data.iana.org/rdap/dns.json) offers a standardized mapping of each TLD to its corresponding RDAP server. +This ensures reliable RDAP queries across registries and predictable resolution for all supported domain extensions. + + + + +### RDAP Servers of the Registries + +The project also depends on the RDAP services provided by individual registries. +These services supply authoritative domain registration data. + +For more information, see: + + + +## Want to redistribute this project? + +What a great idea, we can't wait to see it! 😍 + +This project is open source, and its source code is freely accessible. +You may reuse, modify, and redistribute the project under the terms of the license. + + + diff --git a/docs/src/content/docs/en/legal/license.md b/docs/src/content/docs/en/legal/license.md index c4c478e..2603992 100644 --- a/docs/src/content/docs/en/legal/license.md +++ b/docs/src/content/docs/en/legal/license.md @@ -3,5 +3,7 @@ title: ⚖️ License description: Licensing information detailing usage rights, redistribution terms, and legal conditions for contributing and using the project. --- -This entire project is licensed under [*GNU Affero General Public License v3.0 or later*](https://www.gnu.org/licenses/agpl-3.0.txt). +![GNU AGPL v3 license logo](https://www.gnu.org/graphics/agplv3-with-text-162x68.png) + +This entire project is licensed under [*GNU Affero General Public License v3.0*](https://www.gnu.org/licenses/agpl-3.0.txt) or later. Contributions are welcome as long as they do not contravene the Code of Conduct. diff --git a/docs/tsconfig.json b/docs/tsconfig.json index 8bf91d3..c63b391 100644 --- a/docs/tsconfig.json +++ b/docs/tsconfig.json @@ -1,5 +1,18 @@ { - "extends": "astro/tsconfigs/strict", - "include": [".astro/types.d.ts", "**/*"], - "exclude": ["dist"] + "extends": "astro/tsconfigs/strictest", + "include": [ + ".astro/types.d.ts", + "**/*" + ], + "exclude": [ + "dist" + ], + "compilerOptions": { + "baseUrl": ".", + "paths": { + "~/*": [ + "src/*" + ] + } + } }