YQL-20112: Improve dramatically yql/utils/docs

Introduced `links.json` format to link names to
documentation sections. Implement general links
verification framework. Also fixed two small typos.

Extended Description: https://nda.ya.ru/t/zR4voivb7GzD9r.
commit_hash:e72db0e202b4ff612374c73fa384f70d029f0ef0

1 files changed, 33 insertions, 0 deletions

diff --git a/yql/essentials/utils/docs/verification.h b/yql/essentials/utils/docs/verification.h
new file mode 100644
index 00000000000..4eac54017f8
--- /dev/null
+++ b/yql/essentials/utils/docs/verification.h
@@ -0,0 +1,33 @@
+#pragma once
+
+#include "page.h"
+#include "link.h"
+
+#include <util/generic/map.h>
+#include <util/generic/set.h>
+
+namespace NYql::NDocs {
+
+    enum class EFame {
+        BadLinked,
+        Unknown,
+        Mentioned,
+        Documented,
+    };
+
+    using TStatusesByName = TMap<TString, TString>;
+
+    using TFameReport = THashMap<EFame, TStatusesByName>;
+
+    struct TVerificationInput {
+        TLinks Links;
+        TPages Pages;
+        TSet<TString> Names;
+        TMap<TString, TString> ShortHands;
+    };
+
+    TFameReport Verify(TVerificationInput input);
+
+    double Coverage(const TFameReport& report, const TVector<TString>& names);
+
+} // namespace NYql::NDocs