zensical.toml

[project]
site_name = "fAIr"
site_url = "https://hotosm.github.io/fAIr/"
site_description = "Documentation for fAIr, HOT's open, AI-assisted mapping service."
site_author = "Humanitarian OpenStreetMap Team"
copyright = "Copyright © 2022 - 2026 Humanitarian OpenStreetMap Team"

repo_url = "https://github.com/hotosm/fAIr"
repo_name = "hotosm/fAIr"
edit_uri = "edit/develop/docs/"

extra_css = ["assets/logos.css", "assets/status.css"]

nav = [
  { "Home" = "index.md" },
  { "Overview" = [
    { "What is fAIr" = "overview/what-is-fair.md" },
    { "How it works" = "overview/how-it-works.md" },
    { "User bases" = "overview/who-uses-it.md" },
    { "Models" = "overview/models.md" },
    { "Datasets" = "datasets/index.md" },
    { "Evaluation" = "overview/evaluation.md" },
    { "Validation" = "overview/validation.md" },
    { "FAQ" = "overview/faq.md" },
  ] },
  { "Roadmap" = [
    { "Roadmap" = "roadmap/index.md" },
    { "Milestones" = "progress/milestones.md" },
    { "Vision" = "overview/where-fair-is-going.md" },
    { "About" = "overview/about.md" },
  ] },
  { "Progress" = [
    { "Field projects" = "progress/field-projects.md" },
    { "Activations" = "progress/activations.md" },
  ] },
  { "Community" = [
    { "Contributing" = "community/contributing.md" },
    { "Code of conduct" = "community/code-of-conduct.md" },
  ] },
  { "Guides" = [
    { "Using fAIr" = "guides/using-fair.md" },
    { "Run locally" = "guides/run-locally.md" },
    { "Developer setup" = "guides/developer-setup.md" },
    { "Register a base model" = "guides/register-a-base-model.md" },
  ] },
  { "Architecture" = [
    { "Overview" = "architecture/index.md" },
    { "Backend" = "architecture/backend.md" },
    { "ML pipeline" = "architecture/ml-pipeline.md" },
    { "Frontend" = "architecture/frontend.md" },
    { "Operations" = [
      { "Infrastructure" = "architecture/infrastructure.md" },
      { "Dev environment" = "architecture/dev-environment.md" },
      { "Decision records" = "architecture/decisions/index.md" },
    ] },
  ] },
]

[project.theme]
language = "en"
features = [
  "content.action.edit",
  "content.action.view",
  "content.code.annotate",
  "content.code.copy",
  "content.code.select",
  "content.footnote.tooltips",
  "content.tabs.link",
  "content.tooltips",
  "navigation.footer",
  "navigation.instant",
  "navigation.instant.prefetch",
  "navigation.path",
  "navigation.sections",
  "navigation.top",
  "navigation.tracking",
  "search.highlight",
  "toc.follow",
]

[[project.theme.palette]]
media = "(prefers-color-scheme)"
toggle.icon = "lucide/sun-moon"
toggle.name = "Switch to light mode"

[[project.theme.palette]]
media = "(prefers-color-scheme: light)"
scheme = "default"
toggle.icon = "lucide/sun"
toggle.name = "Switch to dark mode"

[[project.theme.palette]]
media = "(prefers-color-scheme: dark)"
scheme = "slate"
toggle.icon = "lucide/moon"
toggle.name = "Switch to system preference"

[[project.extra.social]]
icon = "fontawesome/brands/github"
link = "https://github.com/hotosm/fAIr"

[project.markdown_extensions]
abbr = {}
admonition = {}
attr_list = {}
def_list = {}
footnotes = {}
md_in_html = {}
toc.permalink = true
pymdownx.arithmatex.generic = true
pymdownx.betterem = {}
pymdownx.caret = {}
pymdownx.details = {}
pymdownx.emoji.emoji_generator = "zensical.extensions.emoji.to_svg"
pymdownx.emoji.emoji_index = "zensical.extensions.emoji.twemoji"
pymdownx.highlight.anchor_linenums = true
pymdownx.highlight.line_spans = "__span"
pymdownx.highlight.pygments_lang_class = true
pymdownx.inlinehilite = {}
pymdownx.keys = {}
pymdownx.magiclink = {}
pymdownx.mark = {}
pymdownx.smartsymbols = {}
pymdownx.superfences.custom_fences = [
  { name = "mermaid", class = "mermaid", format = "pymdownx.superfences.fence_code_format" },
]
pymdownx.tabbed.alternate_style = true
pymdownx.tabbed.combine_header_slug = true
pymdownx.tasklist.custom_checkbox = true
pymdownx.tilde = {}