mirror of
https://github.com/maelgangloff/domain-watchdog.git
synced 2025-12-17 09:45:29 +00:00
docs: update documentation
This commit is contained in:
Maël Gangloff
parent
9326b29728
commit
f2b5e0d732
@ -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',
|
||||
|
||||
90
docs/src/components/testimonial.astro
Normal file
90
docs/src/components/testimonial.astro
Normal file
@ -0,0 +1,90 @@
|
||||
---
|
||||
import {Image} from 'astro:assets'
|
||||
|
||||
interface Props {
|
||||
username: string
|
||||
name: string
|
||||
cite: string
|
||||
}
|
||||
|
||||
const {name, username, cite} = Astro.props
|
||||
---
|
||||
|
||||
<li class="testimonial">
|
||||
<blockquote class="quote" cite={cite}>
|
||||
<slot/>
|
||||
</blockquote>
|
||||
<div class="footer">
|
||||
<Image class="avatar" height="96" width="96" src={'https://avatars.githubusercontent.com/' + username} alt=""/>
|
||||
<div>
|
||||
<p class="name">{name}</p>
|
||||
<a href={cite} class="username">@{username}</a>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
|
||||
<style>
|
||||
.testimonial {
|
||||
display: flex;
|
||||
flex-direction: column;
|
||||
gap: 1.5em;
|
||||
}
|
||||
|
||||
@media (min-width: 50rem) {
|
||||
.testimonial {
|
||||
gap: 2em;
|
||||
}
|
||||
}
|
||||
|
||||
.quote {
|
||||
position: relative;
|
||||
padding-inline-start: 1.5em;
|
||||
}
|
||||
|
||||
.quote::before {
|
||||
position: absolute;
|
||||
content: '';
|
||||
inset-block: 0.5em;
|
||||
inset-inline-start: 0;
|
||||
border-inline-start: 1px solid var(--sl-color-text-accent);
|
||||
}
|
||||
|
||||
.quote > :global(* + *) {
|
||||
margin-top: 0.75em;
|
||||
}
|
||||
|
||||
.footer {
|
||||
display: flex;
|
||||
gap: 1rem;
|
||||
align-items: center;
|
||||
}
|
||||
|
||||
.avatar {
|
||||
--outline-color: rgba(255, 255, 255, 0.33);
|
||||
outline: 1px solid var(--outline-color);
|
||||
outline-offset: -1px;
|
||||
border-radius: 99rem;
|
||||
width: 4em;
|
||||
height: 4em;
|
||||
}
|
||||
|
||||
:global([data-theme='light']) .avatar {
|
||||
--outline-color: rgba(23, 25, 30, 0.33);
|
||||
}
|
||||
|
||||
.name {
|
||||
font-weight: 600;
|
||||
font-size: var(--sl-text-h4);
|
||||
color: var(--sl-color-white);
|
||||
line-height: var(--sl-line-height-headings);
|
||||
}
|
||||
|
||||
.username {
|
||||
text-underline-offset: 4px;
|
||||
color: var(--sl-color-text-accent);
|
||||
}
|
||||
|
||||
.username:hover {
|
||||
color: var(--sl-color-white);
|
||||
}
|
||||
</style>
|
||||
@ -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.
|
||||
|
||||
<ContributorList githubRepo="maelgangloff/domain-watchdog" ignore={['weblate']} />
|
||||
|
||||
## Maintainer
|
||||
|
||||
<Testimonial
|
||||
name="Maël Gangloff"
|
||||
username="maelgangloff"
|
||||
cite="https://maelgangloff.fr"
|
||||
/>
|
||||
|
||||
|
||||
## 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:
|
||||
|
||||
<LinkCard
|
||||
title="Technical Stack"
|
||||
description="Overview of the frameworks, languages, and architectural components used by Domain Watchdog."
|
||||
href="/en/technical-stack/"
|
||||
/>
|
||||
|
||||
## 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.
|
||||
|
||||
<LinkCard
|
||||
title="ICANN"
|
||||
href="/en/definitions/icann/"
|
||||
description="Learn more about ICANN (Internet Corporation for Assigned Names and Numbers)."/>
|
||||
|
||||
|
||||
### 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:
|
||||
|
||||
<LinkCard
|
||||
title="RDAP Protocol"
|
||||
href="/en/definitions/rdap/"
|
||||
description="Learn about the successor to WHOIS designed to handle structured data and privacy access."/>
|
||||
|
||||
## 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.
|
||||
|
||||
|
||||
<LinkCard
|
||||
title="Project License"
|
||||
href="/en/legal/license/"
|
||||
description="Licensing information detailing usage rights, redistribution terms, and legal conditions for contributing and using the project."/>
|
||||
|
||||
@ -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).
|
||||
|
||||
|
||||
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.
|
||||
|
||||
@ -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/*"
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user