vidya 1.6.0

Vidya — programming reference library and queryable corpus for AGNOS
Documentation 
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

//! Vidya — programming reference library and queryable corpus
//!
//! **Vidya** (Sanskrit: विद्या — knowledge, learning) provides a curated,
//! tested, multi-language programming reference. Every concept includes
//! best practices, instructional documentation, and reference implementations
//! in multiple languages — all verified by CI.
//!
//! # Architecture
//!
//! Vidya has two layers:
//!
//! 1. **Content directory** (`content/`) — Markdown docs and source files.
//!    No compilation needed. Humans can read it directly. AI models can
//!    train on it. The files ARE the corpus.
//!
//! 2. **Rust crate** (this) — Queryable interface over the content.
//!    Types, search, comparison, and validation. `cargo doc` generates
//!    a browsable programming reference. MCP tools make it queryable
//!    by agents.
//!
//! # Modules
//!
//! - [`concept`] — Core types: `Concept`, `Topic`, `Example`, `BestPractice`
//! - [`language`] — Supported languages and their metadata
//! - [`registry`] — In-memory concept registry, loaded from content directory
//! - [`loader`] — Content directory loader (TOML → Registry)
//! - [`search`] — Full-text and tag-based search across concepts
//! - [`compare`] — Side-by-side cross-language comparison
//! - [`validate`] — Compile/run verification of examples
//! - [`error`] — Error types
//!
//! # Example
//!
//! ```rust
//! use vidya::{Language, Registry};
//!
//! let registry = Registry::new();
//! // Look up string handling in Rust
//! if let Some(concept) = registry.get("strings") {
//!     println!("{}", concept.description);
//!     if let Some(example) = concept.example(Language::Rust) {
//!         println!("{}", example.code);
//!     }
//! }
//! ```

pub mod compare;
pub mod concept;
pub mod error;
pub mod language;
pub mod loader;
pub mod registry;
pub mod search;
pub mod validate;

#[cfg(feature = "logging")]
pub mod logging;

#[cfg(feature = "mcp")]
pub mod mcp;

// ── Core types ─────────────────────────────────────────────────────────────
pub use concept::{BestPractice, Concept, Example, Gotcha, PerformanceNote, Topic};
pub use error::{Result, VidyaError};
pub use language::Language;
pub use registry::Registry;

// ── Operations ─────────────────────────────────────────────────────────────
pub use compare::Comparison;
pub use search::{SearchQuery, SearchResult};
pub use validate::ValidationResult;