docs: add page description

This commit is contained in:
Maël Gangloff 2025-11-16 01:23:11 +01:00
parent 9bed601d9c
commit 88bd52e133
No known key found for this signature in database
GPG Key ID: 11FDC81C24A7F629
15 changed files with 15 additions and 0 deletions

View File

@ -1,5 +1,6 @@
--- ---
title: Add a Provider title: Add a Provider
description: Step-by-step guide to adding a new Provider, with backend, frontend, and testing instructions to integrate a registrar into the project.
--- ---
import {FileTree, Steps, Code, LinkCard} from "@astrojs/starlight/components"; import {FileTree, Steps, Code, LinkCard} from "@astrojs/starlight/components";

View File

@ -1,5 +1,6 @@
--- ---
title: Code of Conduct title: Code of Conduct
description: Code of conduct outlining community standards and guidelines for respectful collaboration within the project.
--- ---
## Our Pledge ## Our Pledge

View File

@ -1,5 +1,6 @@
--- ---
title: Pull Requests title: Pull Requests
description: Instructions for submitting pull requests.
--- ---
When you want to propose a change to the source code, you will need to create a Pull Request on this project's GitHub When you want to propose a change to the source code, you will need to create a Pull Request on this project's GitHub

View File

@ -1,5 +1,6 @@
--- ---
title: Technical stack title: Technical stack
description: Overview of the project's technical stack, including frameworks, languages, and architecture used throughout the system.
--- ---
This page lists the main technologies used in the project, with links to their documentation. Specific version This page lists the main technologies used in the project, with links to their documentation. Specific version

View File

@ -1,5 +1,6 @@
--- ---
title: Translation title: Translation
description: This project is available in several languages, the current translation status is available here.
--- ---
The project is translated into several languages to allow as many people as possible to easily understand the interface. The project is translated into several languages to allow as many people as possible to easily understand the interface.

View File

@ -1,5 +1,6 @@
--- ---
title: Connector title: Connector
description: Learn how the Backorder Connector works, its flow, requirements, and how it integrates with registrar APIs for domain backordering.
--- ---
import {LinkCard, Steps} from '@astrojs/starlight/components'; import {LinkCard, Steps} from '@astrojs/starlight/components';

View File

@ -1,5 +1,6 @@
--- ---
title: Supported registrar list title: Supported registrar list
description: List of registrars supported for domain backorders, with details on compatibility.
--- ---
import {LinkButton} from '@astrojs/starlight/components'; import {LinkButton} from '@astrojs/starlight/components';

View File

@ -1,5 +1,6 @@
--- ---
title: Domain search title: Domain search
description: Domain search feature overview
--- ---
:::tip[Did you know?] :::tip[Did you know?]

View File

@ -1,5 +1,6 @@
--- ---
title: Watchlist title: Watchlist
description: Learn how the domain watchlist works, enabling users to monitor domains and receive updates on changes.
--- ---
import {Steps} from '@astrojs/starlight/components'; import {Steps} from '@astrojs/starlight/components';

View File

@ -1,5 +1,6 @@
--- ---
title: Configuration title: Configuration
description: Configuration guide explaining environment variables and settings required to run and customize the project.
--- ---
import {LinkCard} from '@astrojs/starlight/components'; import {LinkCard} from '@astrojs/starlight/components';

View File

@ -1,5 +1,6 @@
--- ---
title: Docker Compose installation title: Docker Compose installation
description: Guide to installing the project using Docker Compose, with setup steps, and deployment notes.
--- ---
import {LinkCard} from '@astrojs/starlight/components'; import {LinkCard} from '@astrojs/starlight/components';

View File

@ -1,5 +1,6 @@
--- ---
title: Manual installation title: Manual installation
description: Manual installation guide with system requirements, dependencies, and step-by-step instructions to install the project from source.
--- ---
import {FileTree, LinkCard, Steps} from '@astrojs/starlight/components'; import {FileTree, LinkCard, Steps} from '@astrojs/starlight/components';

View File

@ -1,5 +1,6 @@
--- ---
title: Manual Upgrade title: Manual Upgrade
description: Upgrade guide explaining how to safely update the project, including migrations, and versioning details.
--- ---
import {Steps} from "@astrojs/starlight/components"; import {Steps} from "@astrojs/starlight/components";

View File

@ -1,5 +1,6 @@
--- ---
title: License 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 or later*](https://www.gnu.org/licenses/agpl-3.0.txt).

View File

@ -1,5 +1,6 @@
--- ---
title: Security policy title: Security policy
description: Security policy describing vulnerability reporting, and guidelines to keep the project secure.
--- ---
## Reporting a Vulnerability ## Reporting a Vulnerability