formal-ai 0.210.0

Formal symbolic AI implementation with OpenAI-compatible APIs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113

// formal-ai documentation hub (issue #479).
//
// /docs/ is the documentation entry point. It links to:
//
//   • the Rust API reference (/docs/api/) — generated by `cargo doc` during the
//     GitHub Pages deploy and served as static HTML, and
//   • the prose documentation that lives in the repository as Markdown
//     (case studies, user journeys, the contributing guide).
//
// Like the landing page, the rendering/theming/locale machinery lives in the
// shared site-chrome.js, so this file is just the page's config.
// `window.FormalAiDocs` is published for the e2e suite.

(function (global) {
  "use strict";

  var chrome = global.FormalAiSiteChrome;
  if (!chrome || typeof chrome.createChooser !== "function") {
    return;
  }

  var REPO = "https://github.com/link-assistant/formal-ai";

  chrome.createChooser({
    rootId: "docs-app",
    topbarClass: "landing-topbar",
    brandHref: "../",
    repoUrl: REPO,
    exposeAs: "FormalAiDocs",
    destinations: [
      // In-site: the generated Rust API reference.
      { id: "api", href: "api/", icon: "📘", titleKey: "navApiTitle", descKey: "navApiDesc", actionKey: "navApiAction" },
      // Prose docs live in the repo as Markdown — link out to GitHub.
      { id: "cases", href: REPO + "/tree/main/docs/case-studies", external: true, icon: "🔬", titleKey: "navCasesTitle", descKey: "navCasesDesc", actionKey: "navCasesAction" },
      { id: "journeys", href: REPO + "/blob/main/docs/USER-JOURNEYS.md", external: true, icon: "🧭", titleKey: "navJourneysTitle", descKey: "navJourneysDesc", actionKey: "navJourneysAction" },
      { id: "contributing", href: REPO + "/blob/main/CONTRIBUTING.md", external: true, icon: "🛠️", titleKey: "navContribTitle", descKey: "navContribDesc", actionKey: "navContribAction" },
    ],
    copy: {
      en: {
        heading: "Documentation",
        eyebrow: "formal-ai documentation",
        summary:
          "Everything you need to build on formal-ai: the Rust API reference, in-depth issue case studies, end-to-end user journeys, and the contributing guide.",
        navApiTitle: "API reference",
        navApiDesc: "The Rust API reference, generated from the source with cargo doc.",
        navApiAction: "Browse the API",
        navCasesTitle: "Case studies",
        navCasesDesc: "In-depth analyses of notable issues, including #479.",
        navCasesAction: "Read case studies",
        navJourneysTitle: "User journeys",
        navJourneysDesc: "How people actually use formal-ai, start to finish.",
        navJourneysAction: "View user journeys",
        navContribTitle: "Contributing",
        navContribDesc: "Set up the project, run the tests, and ship a change.",
        navContribAction: "Start contributing",
      },
      ru: {
        heading: "Документация",
        eyebrow: "Документация formal-ai",
        summary:
          "Всё необходимое для работы с formal-ai: справочник API на Rust, подробные разборы issue, сквозные пользовательские сценарии и руководство для контрибьюторов.",
        navApiTitle: "Справочник API",
        navApiDesc: "Справочник API на Rust, сгенерированный из исходного кода с помощью cargo doc.",
        navApiAction: "Открыть API",
        navCasesTitle: "Разборы issue",
        navCasesDesc: "Подробные разборы важных issue, включая #479.",
        navCasesAction: "Читать разборы",
        navJourneysTitle: "Пользовательские сценарии",
        navJourneysDesc: "Как люди на самом деле используют formal-ai, от начала до конца.",
        navJourneysAction: "Смотреть сценарии",
        navContribTitle: "Участие в разработке",
        navContribDesc: "Настройте проект, запустите тесты и внесите изменение.",
        navContribAction: "Начать участвовать",
      },
      zh: {
        heading: "文档",
        eyebrow: "formal-ai 文档",
        summary:
          "在 formal-ai 上进行开发所需的一切：Rust API 参考、深入的 issue 案例研究、端到端用户旅程，以及贡献指南。",
        navApiTitle: "API 参考",
        navApiDesc: "由 cargo doc 从源代码生成的 Rust API 参考。",
        navApiAction: "浏览 API",
        navCasesTitle: "案例研究",
        navCasesDesc: "对重要 issue 的深入分析，包括 #479。",
        navCasesAction: "阅读案例研究",
        navJourneysTitle: "用户旅程",
        navJourneysDesc: "人们如何从头到尾实际使用 formal-ai。",
        navJourneysAction: "查看用户旅程",
        navContribTitle: "参与贡献",
        navContribDesc: "搭建项目、运行测试并提交更改。",
        navContribAction: "开始贡献",
      },
      hi: {
        heading: "दस्तावेज़",
        eyebrow: "formal-ai दस्तावेज़",
        summary:
          "formal-ai पर निर्माण के लिए आवश्यक सब कुछ: Rust API संदर्भ, issue के गहन केस स्टडी, एंड-टू-एंड उपयोगकर्ता यात्राएँ, और योगदान गाइड।",
        navApiTitle: "API संदर्भ",
        navApiDesc: "cargo doc द्वारा सोर्स से जनित Rust API संदर्भ।",
        navApiAction: "API ब्राउज़ करें",
        navCasesTitle: "केस स्टडी",
        navCasesDesc: "#479 सहित उल्लेखनीय issues का गहन विश्लेषण।",
        navCasesAction: "केस स्टडी पढ़ें",
        navJourneysTitle: "उपयोगकर्ता यात्राएँ",
        navJourneysDesc: "लोग वास्तव में formal-ai का उपयोग शुरू से अंत तक कैसे करते हैं।",
        navJourneysAction: "यात्राएँ देखें",
        navContribTitle: "योगदान",
        navContribDesc: "प्रोजेक्ट सेट करें, टेस्ट चलाएँ और बदलाव भेजें।",
        navContribAction: "योगदान शुरू करें",
      },
    },
  });
})(typeof window !== "undefined" ? window : globalThis);