55 lines
3.3 KiB
Zig
55 lines
3.3 KiB
Zig
//! Embeds the documentation files the drift tests guard. Module root for the
|
|
//! `docs_files` anonymous import (test builds only) — @embedFile paths resolve
|
|
//! relative to this file.
|
|
|
|
pub const reference_configuration_md = @embedFile("reference/configuration.md");
|
|
pub const reference_cli_md = @embedFile("reference/cli.md");
|
|
pub const reference_files_and_directories_md = @embedFile("reference/files-and-directories.md");
|
|
|
|
pub const tutorial_get_started_md = @embedFile("tutorial/get-started.md");
|
|
|
|
pub const howto_back_up_and_restore_md = @embedFile("how-to/back-up-and-restore.md");
|
|
pub const howto_enable_doh_and_dot_md = @embedFile("how-to/enable-doh-and-dot.md");
|
|
pub const howto_install_with_docker_md = @embedFile("how-to/install-with-docker.md");
|
|
pub const howto_install_with_nix_md = @embedFile("how-to/install-with-nix.md");
|
|
pub const howto_install_with_systemd_md = @embedFile("how-to/install-with-systemd.md");
|
|
pub const howto_set_up_admin_authentication_md = @embedFile("how-to/set-up-admin-authentication.md");
|
|
pub const howto_upgrade_md = @embedFile("how-to/upgrade.md");
|
|
pub const howto_verify_a_release_md = @embedFile("how-to/verify-a-release.md");
|
|
|
|
pub const explanation_configuration_model_md = @embedFile("explanation/configuration-model.md");
|
|
|
|
pub const Page = struct {
|
|
/// Repo-relative path, so a failing assertion names the file to edit.
|
|
path: []const u8,
|
|
text: []const u8,
|
|
};
|
|
|
|
/// Every page this module embeds. A guard that must hold for all of them walks
|
|
/// this table instead of naming each decl.
|
|
pub const pages: []const Page = &.{
|
|
.{ .path = "docs/reference/configuration.md", .text = reference_configuration_md },
|
|
.{ .path = "docs/reference/cli.md", .text = reference_cli_md },
|
|
.{ .path = "docs/reference/files-and-directories.md", .text = reference_files_and_directories_md },
|
|
.{ .path = "docs/tutorial/get-started.md", .text = tutorial_get_started_md },
|
|
.{ .path = "docs/how-to/back-up-and-restore.md", .text = howto_back_up_and_restore_md },
|
|
.{ .path = "docs/how-to/enable-doh-and-dot.md", .text = howto_enable_doh_and_dot_md },
|
|
.{ .path = "docs/how-to/install-with-docker.md", .text = howto_install_with_docker_md },
|
|
.{ .path = "docs/how-to/install-with-nix.md", .text = howto_install_with_nix_md },
|
|
.{ .path = "docs/how-to/install-with-systemd.md", .text = howto_install_with_systemd_md },
|
|
.{ .path = "docs/how-to/set-up-admin-authentication.md", .text = howto_set_up_admin_authentication_md },
|
|
.{ .path = "docs/how-to/upgrade.md", .text = howto_upgrade_md },
|
|
.{ .path = "docs/how-to/verify-a-release.md", .text = howto_verify_a_release_md },
|
|
.{ .path = "docs/explanation/configuration-model.md", .text = explanation_configuration_model_md },
|
|
};
|
|
|
|
/// The pages that paste a transcript naming the running binary's version. Each
|
|
/// one must print the `<version>` placeholder rather than the version of the
|
|
/// day the page was written.
|
|
pub const version_transcript_pages: []const Page = &.{
|
|
.{ .path = "docs/tutorial/get-started.md", .text = tutorial_get_started_md },
|
|
.{ .path = "docs/how-to/install-with-docker.md", .text = howto_install_with_docker_md },
|
|
.{ .path = "docs/how-to/install-with-systemd.md", .text = howto_install_with_systemd_md },
|
|
.{ .path = "docs/how-to/upgrade.md", .text = howto_upgrade_md },
|
|
};
|