Skip to content

Solvronix/Solvronix-Docs

Repository files navigation

Solvronix Docs

Official documentation site for Edvronix and Solvronix Desk — built with Docusaurus 3 and deployed to GitHub Pages.

Live site: docs.solvronix.com


Products Covered

Edvronix

A production-ready Frappe/ERPNext application for K-12 school management in Pakistan. Covers fee management, student admissions, attendance, timetables, guardian records, parent portal, and analytics dashboards.

Solvronix Desk

A professional white-label theme for Frappe/ERPNext that transforms the default ERP interface into a modern, branded SaaS-like product. Includes a command palette, dual color system, dark mode, slim icon sidebar, and a smart home dashboard.


Tech Stack

Layer Details
Framework Docusaurus 3.10.1
Frontend React 19
Search @easyops-cn/docusaurus-search-local (no backend required)
CI/CD GitHub Actions
Hosting GitHub Pages

Getting Started

Prerequisites

  • Node.js 20+
  • npm

Installation

npm ci

Local Development

npm start

Opens a dev server at http://localhost:3000 with hot reload.

Build

npm run build

Generates the static site into the build/ directory.

Preview Production Build

npm run serve

Project Structure

├── docs/
│   ├── edvronix/           # Edvronix product documentation
│   │   ├── intro.md
│   │   ├── installation.md
│   │   ├── initial-setup.md
│   │   ├── fee-management/
│   │   ├── students/
│   │   ├── timetable/
│   │   ├── parent-portal/
│   │   └── reports/
│   └── solvronix-desk/     # Solvronix Desk documentation
│       ├── intro.md
│       ├── installation.md
│       ├── quick-start.md
│       ├── theme/
│       ├── features/
│       └── reference/
├── src/
│   ├── components/         # React components (feature cards)
│   ├── css/                # Global styles and brand tokens
│   └── pages/              # Landing page
├── static/img/             # Logos and screenshots
├── docusaurus.config.js    # Site configuration
├── sidebars.js             # Edvronix sidebar
└── sidebars-desk.js        # Solvronix Desk sidebar

Deployment

The site deploys automatically to GitHub Pages on every push to main via GitHub Actions (.github/workflows/deploy.yml).

To deploy manually:

npm run deploy

Contributing

  1. Fork the repo and create a branch from main.
  2. Make your changes inside the relevant docs/ subfolder.
  3. Run npm start to preview changes locally.
  4. Open a pull request — the CI build will validate the site before merge.

All documentation is written in Markdown/MDX. No code changes are needed for content updates.


Related Repositories


License

MIT

About

Official documentation for Solvronix products — Edvronix school management system and Solvronix Desk theme for Frappe/ERPNext

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors