bench get-app https://github.com/TrungPham-oops/frappe-wiki-rd

[![Listed on Frappe Gems](https://frappegems.com/api/method/frappe_gems.seo.badge?app=TrungPham-oops%2Ffrappe-wiki-rd)](https://frappegems.com/gems/apps/TrungPham-oops/frappe-wiki-rd)

--- ## 📌 R&D Overview This project is a **Research & Development (R&D)** exploration of **Frappe Wiki** as an internal **ERP Knowledge Base system**. The objective is to evaluate: - Core features of Frappe Wiki - Usability for ERP and Helpdesk workflows - Applicability in real-world enterprise scenarios --- ## 🎯 R&D Scope This R&D includes: - Setting up Frappe Wiki locally - Exploring key features (page creation, hierarchy, search, revision, permission) - Building a structured ERP knowledge base - Evaluating system strengths and limitations --- ## 🧪 Implementation During this R&D, the following tasks were completed: - Set up Frappe Framework and Wiki app locally - Created structured documentation for ERP use cases - Built hierarchical navigation using group pages - Added Overview pages to improve UX - Configured routing and slug system - Tested search, revision, and permission features - Debugged routing, cache, and UI issues --- ## 📸 Screenshots ### 🖥️ Overall Interface  --- ### 📂 Sidebar Structure  --- ### 📄 Overview Page  --- ## 📂 Demo Structure ```text ERP Knowledge Base ├── User Guide │ ├── User Guide Overview │ ├── Hướng dẫn đăng nhập │ ├── Tạo Ticket Helpdesk │ └── Xem chấm công ├── FAQ │ ├── FAQ Overview │ ├── Không đăng nhập được │ └── Không thấy dữ liệu └── Process ├── Process Overview ├── Quy trình support └── Quy trình báo lỗi hệ thống ``` --- ## 🧩 Feature Evaluation | Feature | Status | Notes | |--------------------------|--------|------| | Create Page | ✅ | markdown supported | | Edit Content | ✅ | direct editing | | Structure (Hierarchy) | ✅ | parent-child | | Sidebar Navigation | ✅ | auto-generated | | Search | ⚠️ | HTTP 500 error (local) | | Revision / History | ⚠️ | backend only | | Permission | ⚠️ | basic login control | | Approval Workflow | ❌ | not available | | UI Experience | ✅ | simple and clean | --- ## 🚀 Features - Structured Wiki System - Sidebar Navigation - Overview Pages for each section - ERP Knowledge Base demo --- ## 🧠 Key Findings ### ✅ Strengths - Easy to use with Markdown - Integrated with Frappe ecosystem - Flexible tree-based structure - Suitable for documentation and FAQ - Lightweight and fast to deploy --- ### ⚠️ Limitations - Search instability in local setup - Revision not clearly visible in UI - No approval workflow for content management - Basic permission system (limited role control) --- ## 🏗️ Design Decisions ### ✅ Overview Pages Frappe Wiki group pages do not render content directly. To improve usability, **Overview pages** were created: - Provide context for each section - Improve navigation experience - Simulate real-world Knowledge Base systems --- ### ✅ Routing Rules - Route must be **slug-only (no `/docs`)** - Must use: - lowercase - hyphen-separated words - no special characters Example: ✅ huong-dan-dang-nhap ❌ /hướng-dẫn-đăng-nhập --- ### ✅ Hierarchy Rules - Group pages act as **containers** - Leaf pages contain actual content - A page with children must be marked as **Group** --- ### ERP / Helpdesk Scenario Frappe Wiki supports: - User self-service documentation - FAQ for common issues - Standardized support processes Example workflow: User gặp lỗi đăng nhập → Tìm kiếm FAQ → Đọc hướng dẫn → Nếu chưa giải quyết → tạo ticket --- ## 📌 Lessons Learned - Proper slug configuration is required for routing - Cache must be cleared after route changes - Group pages are structural only (no direct content rendering) - Overview pages significantly improve UX - Wiki Document replaces deprecated Wiki Page (v3) --- ## ✅ Final Evaluation Frappe Wiki is a **lightweight Knowledge Base solution** suitable for ERP/Helpdesk environments. ### 👍 Suitable for: - Internal documentation - User guides - FAQ systems ### ⚠️ Needs improvement: - Search reliability - Permission granularity - Content approval workflow --- ## 🏁 Conclusion This R&D shows that Frappe Wiki can be effectively used as an internal Knowledge Base system. Although some enterprise features are limited, it provides a solid foundation for documentation and support workflows. --- ## 📄 Report Full report is available here: BÁO CÁO ĐÁNH GIÁ HỆ THỐNG WIKI.docx --- ## 👤 Author - Name: Phạm Tuấn Anh Trung - Role: AI Intern - Project: Frappe Wiki R&D for ERP Knowledge Base