Skip to content

ezequieldlv/knowledge-base-system

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

15 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

⚑ Knowledge Base System (Docs as Code)

A modern, high-performance internal documentation platform engineered to replace legacy tools (Google Sites). Built with MkDocs, Python, and JavaScript.

System Status Built By

πŸš€ The Challenge

The team was struggling with a decentralized and slow legacy knowledge base (Google Sites). Information retrieval was inefficient during critical support calls, impacting KPIs like AHT (Average Handle Time).

πŸ› οΈ The Solution

I engineered a Docs-as-Code solution to centralize operations, strictly following SRE principles:

  • Performance: Static site generation for <100ms load times.
  • UX/UI: "Dark Mode" terminal aesthetic to reduce eye strain for operators.
  • Automation: JS scripts to fetch real-time metrics and team birthdays.
  • Search: Instant client-side search indexing.

πŸ’» Tech Stack

  • Core: MkDocs (Python)
  • Theme: Material for MkDocs (Customized)
  • Scripting: JavaScript (ES6) for dynamic dashboard widgets.
  • Styling: CSS3 (Custom Variables & Animations).
  • Deployment: Netlify (CI/CD).

πŸ”„ Transformation (Legacy vs Modern)

Witness the evolution from a static, slow interface to a high-performance SRE-grade platform.

Legacy System (Google Sites) New Knowledge Base (MkDocs)
Old System New System
Slow, decentralized, hard to maintain. <100ms load, Dark Mode, Git-backed.

πŸ“Έ Features

  • Service Monitor: Real-time KPI dashboard simulation.
  • Interactive Scripts: "Copy-to-clipboard" functionality for support scripts.
  • Technical Wiki: Syntax highlighting for troubleshooting guides.

Built with ❀️ by Ezequiel De la Vega

About

Internal documentation platform using Docs-as-Code approach.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published