> ## Knowledge Base Index
> Fetch the complete knowledge base index at: https://docs.brainframe.com/sitemap.xml
> Use this file to discover available pages before exploring further.
> Pure-Markdown content can be obtained by appending a '.md' suffix to the content URLs listed in the sitemap (without the trailing slash).

# Document Versioning

# 📝 **Document Versioning in Brainframe**  
> **"Track every change, keep full history."**  
> *From draft to approved version, Brainframe records it all.*  

All newly created documents start in **Draft** mode. Every time you save, Brainframe records a **time-stamped history entry**.  

---

## 1️⃣ Assign a Version  
Convert a draft into a versioned document:  

![](https://storage.crisp.chat/users/helpdesk/website/-/3/f/2/6/3f26ce462760bc00/screenshot-2026-07-07-at-16430_yj0vbi.png =983xauto)

1. Open the document in **Document View**.  
2. Click **Assign Version** in the top bar.  
3. Enter the new version number using the **x.y.z** format (e.g., `1.2.0`) and save.  

---

## 2️⃣ Versioning Rules (SemVer)  
Brainframe uses [Semantic Versioning](https://semver.org/):  

* **x – MAJOR**: First finalized releases or complete rewrites.  
* **y – MINOR**: Backward-compatible updates (added explanations, small features).  
* **z – PATCH**: Tiny fixes (typos, links, formatting).  

![](https://storage.crisp.chat/users/helpdesk/website/-/3/f/2/6/3f26ce462760bc00/screenshot-2026-07-07-at-16434_20y0ug.png =328xauto)
| 📌 You can also define your own increment criteria.  

---

## 3️⃣ Mark as Reviewed (No Content Change)  
Track a review without creating a new version:  
![](https://storage.crisp.chat/users/helpdesk/website/-/3/f/2/6/3f26ce462760bc00/screenshot-2026-07-07-at-16441_18jr6ly.png =842xauto)

1. Open the **Activities** tab.  
2. Enable **Mark this document version as reviewed**.  
3. Save.  

📌 *This updates the review/age tracking date without changing the version.*  

---

## 4️⃣ Approvals After Version Assignment  
If the [document type ](https://docs.brainframe.com/en/article/document-types-templates-lssmkc/)has an **approval workflow** configured:  

![](https://storage.crisp.chat/users/helpdesk/website/-/3/f/2/6/3f26ce462760bc00/screenshot-2026-07-07-at-16452_1ddoi7.png =1112xauto)
* After assigning a version, the workflow stages (e.g., *Review*, *Approve/Reject*) appear.  
* Use **Approve** or **Reject** to progress through the configured stages.  

---

## 5️⃣ View and Compare Revisions  
The **Revisions tab** gives you a complete audit trail:  

![](https://storage.crisp.chat/users/helpdesk/website/-/3/f/2/6/3f26ce462760bc00/5_ertppu.png =891xauto)
1. View the **full version history** (who changed/approved what and when).  
2. Select any previous version to see its content. Use **Show changes** to highlight differences between versions. *Available only for documents created with the **Standard Editor**.*  

---

## 6️⃣ Best Practices  
* 🔄 **Use review marks** for periodic checks where no content change is needed.  
* 🚨 **Be consistent with SemVer** so your team understands update types.  
* 📝 **Add clear version notes** to document why changes were made.  
* 👀 **Compare revisions regularly** to track subtle changes.  
* ✅ **Tie approvals to versions** for a complete audit trail.  

---

## 🎯 Visual Checklist  
* [x] Version assigned using SemVer  
* [x] Review mark used where no content change occurred  
* [ ] Approval workflow completed  
* [ ] Revision history checked and compared  
* [ ] Version notes documented for audit readiness