Skip to content

docs: add contributor tip for versioning model illustration #351

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
RealGanadores wants to merge 3 commits into
base: main
Choose a base branch
from
Open

docs: add contributor tip for versioning model illustration #351

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7533747
docs: add contributor tip for versioning model illustration
RealGanadores Aug 10, 2026
04f8617
docs: fix typo in faq
RealGanadores Aug 10, 2026
14818cd
docs: improve clarity in README note.
RealGanadores Aug 10, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 3 additions & 31 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 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.
:::

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"]
Expand Down
2 changes: 1 addition & 1 deletion docs/builder/faq.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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?

Expand Down