From 753374749007678ebb9036c6e30093c50640186d Mon Sep 17 00:00:00 2001 From: RealGanadores <69043907+RealGanadores@users.noreply.github.com> Date: Mon, 10 Aug 2026 10:46:31 +0300 Subject: [PATCH 1/3] docs: add contributor tip for versioning model illustration --- README.md | 34 +++------------------------------- 1 file changed, 3 insertions(+), 31 deletions(-) diff --git a/README.md b/README.md index c860fb18..b13a8660 100644 --- a/README.md +++ b/README.md @@ -5,38 +5,10 @@ Consolidated documentation for the Miden rollup --- ## Documentation Dependency & Versioning Model +:::tip IMPORTANT FOR CONTRIBUTORS +Please note that version tags like v0.12.3 or v0.19.1 listed in the diagram below are for illustrative architecture purposes only. For actual contributions, always refer to the latest mainnet releases and modify source files strictly within the docs/ directory. Do not alter ingested legacy files. +::: -This documentation site combines content **authored in this repo** with content **ingested from external Miden repositories**. Understanding this ownership model is critical for contributors. - -### Dependency Diagram - -```mermaid -flowchart TD - subgraph ThisRepo["0xMiden/miden-docs"] - subgraph DocsDir["docs/ (authored here)"] - BuilderDir["builder/"] - BuilderQS["builder/get-started/"] - BuilderSC["builder/smart-contracts/"] - BuilderTutorials["builder/tutorials/"] - BuilderTools["builder/tools/"] - BuilderGuardian["builder/miden-guardian/"] - BuilderMigration["builder/migration/"] - BuilderFAQ["builder/faq.md"] - BuilderGlossary["builder/glossary.md"] - ReferenceLanding["reference/index.md"] - end - - subgraph VersionedDocs["versioned_docs/ (snapshots)"] - subgraph V012["version-0.12/"] - V012QS["quick-start/ (legacy)"] - V012Base["miden-base/"] - V012VM["miden-vm/"] - V012Node["miden-node/"] - V012Compiler["compiler/"] - V012Client["miden-client/"] - V012Tutorials["miden-tutorials/"] - end - subgraph V011["version-0.11/"] V011Content["(same structure)"] end subgraph VCurrent["version-0.13+ / version-0.14"] From 04f8617ad1e9de7faac053eecda93dd822f42320 Mon Sep 17 00:00:00 2001 From: RealGanadores <69043907+RealGanadores@users.noreply.github.com> Date: Mon, 10 Aug 2026 11:47:54 +0300 Subject: [PATCH 2/3] docs: fix typo in faq --- docs/builder/faq.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/builder/faq.md b/docs/builder/faq.md index 0028e47c..52f9012f 100644 --- a/docs/builder/faq.md +++ b/docs/builder/faq.md @@ -2,7 +2,7 @@ ## How is privacy implemented in Miden? -Miden leverages zero-knowledge proofs and client side execution and proving to provide security and privacy. +Miden leverages zero-knowledge proofs and client-side execution and proving to provide security and privacy. ## Does Miden support encrypted notes? From 14818cd7c1b4109b771627cdd208cc07c343fe50 Mon Sep 17 00:00:00 2001 From: RealGanadores <69043907+RealGanadores@users.noreply.github.com> Date: Mon, 10 Aug 2026 12:07:59 +0300 Subject: [PATCH 3/3] docs: improve clarity in README note. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index b13a8660..92e34042 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ Consolidated documentation for the Miden rollup ## Documentation Dependency & Versioning Model :::tip IMPORTANT FOR CONTRIBUTORS -Please note that version tags like v0.12.3 or v0.19.1 listed in the diagram below are for illustrative architecture purposes only. For actual contributions, always refer to the latest mainnet releases and modify source files strictly within the docs/ directory. Do not alter ingested legacy files. +Please note that version tags like v0.12.3 or v0.19.1 shown in the diagram below are for illustrative architecture purposes only. For actual contributions, always refer to the latest mainnet releases and modify source files strictly within the docs/ directory. Do not alter ingested legacy files. ::: V011Content["(same structure)"]