{
"guide-assessments-creation": {
"id": "guide-assessments-creation",
"title": "Creating Assessments and Weighted Scoring",
"roles": [
"employee",
"teacher"
],
"permissions": [
"enter_score"
],
"routes": [],
"components": [],
"assets": [],
"missing_assets": [],
"body": "\n# Creating Assessments\n\nAssessments define the grading structure for your subjects.\n\n## Defining Assessment Types\nCommon types include **Test 1**, **Midterm**, **Project**, and **Final Exam**.\n\n1. Navigate to the **Subject > Assessments** tab.\n2. Click **Add Assessment**.\n3. Set the **Max Score** and **Due Date**.\n\n## Weighted Scoring\nEnsure that all assessments in a term add up to the required total (usually 100%) for graduation and report cards.\n\n\nOnce you start entering scores, the 'Assessment Type' cannot be changed without deleting the scores first.\n\n",
"raw_file": "academics/assessments.mdx"
},
"guide-daily-attendance": {
"id": "guide-daily-attendance",
"title": "Marking Daily Attendance and Reports",
"roles": [
"employee",
"teacher"
],
"permissions": [
"attendance"
],
"routes": [],
"components": [],
"assets": [],
"missing_assets": [],
"body": "\n# Daily Attendance\n\nTracking attendance is vital for student safety and academic performance monitoring.\n\n## Marking the Register\nClass teachers can access the register by clicking on **Attendance > Register** in their dashboard.\n\n1. Select the date and batch.\n2. Mark students as **Present**, **Absent**, or **Late**.\n3. Click **Submit**.\n\n\n\n## Automated SMS Alerts\nIf configured, BlueBic can send automatic SMS notifications to parents whenever a student is marked absent.\n\n\nAttendance data is automatically pulled into the end-of-term report card.\n\n",
"raw_file": "academics/attendance.mdx"
},
"guide-academics-curriculum": {
"id": "guide-academics-curriculum",
"title": "Managing Subjects and Curriculum Structure",
"roles": [
"employee",
"admin"
],
"permissions": [
"subject_master"
],
"routes": [],
"components": [],
"assets": [],
"missing_assets": [],
"body": "\n# Managing Curriculum\n\nBlueBic's curriculum engine allows you to define a standardized list of subjects across your entire school.\n\n## Subject Bases\nA **Subject Base** is the global name for a subject (e.g., \"Mathematics\"). \n- Navigate to **Academic > Subject Bases**.\n- Add all subjects offered in your school here.\n- You can categorize them into \"Core\", \"Elective\", or \"Vocational\".\n\n## Linking to Batches\nOnce defined, a Subject Base is linked to a specific Batch to create a **Subject Instance** where scores are recorded.\n\n\n\n\nDeleting a Subject Base will remove it from all future academic sessions. Ensure it is truly obsolete before deleting.\n\n",
"raw_file": "academics/curriculum.mdx"
},
"guide-academics-grading": {
"id": "guide-academics-grading",
"title": "Understanding the Grading Engine and Pass Criteria",
"roles": [
"employee",
"teacher"
],
"permissions": [
"view_score"
],
"routes": [],
"components": [],
"assets": [],
"missing_assets": [],
"body": "\n# Grading Engine\n\nBlueBic calculates final term scores based on a combination of assessment performance and attendance (if configured).\n\n## Cumulative Scores\nThe system automatically sums up all assessment scores for a student in a subject.\n- **Example**: Test 1 (15/20) + Midterm (15/20) + Exam (40/60) = **70/100**.\n\n## Automated Letter Grading\nBased on the **Grade Scale** assigned to the batch, the score is mapped to a letter (e.g., 70 = B).\n\n\n\n\nTeachers can lock their scoresheets after entry to prevent accidental edits before report card generation.\n\n",
"raw_file": "academics/grading.mdx"
},
"guide-report-cards": {
"id": "guide-report-cards",
"title": "Generating and Publishing Termly Report Cards",
"roles": [
"employee",
"admin"
],
"permissions": [
"report_cards"
],
"routes": [],
"components": [],
"assets": [],
"missing_assets": [],
"body": "\n# Generating Report Cards\n\nBlueBic automates the complex process of compiling scores, attendance, and behavioral data into professional report cards.\n\n## Step 1: Score Verification\nEnsure all subject teachers have finalized their scoresheets and class teachers have entered behavioral grades.\n\n## Step 2: Running the Processor\n- Go to **Academics > Report Cards**.\n- Select the Batch and Term.\n- Click **Generate Reports**.\n\n## Step 3: Publishing\nOnce verified, click **Publish** to make the results visible to parents and students in their respective portals.\n\n\n\n\nUse the \"Batch Download\" feature to generate a single PDF containing all students' reports for printing.\n\n",
"raw_file": "academics/report_cards.mdx"
},
"guide-transport-management": {
"id": "guide-transport-management",
"title": "Managing School Transport and Bus Routes",
"roles": [
"employee",
"admin"
],
"permissions": [
"transportation"
],
"routes": [],
"components": [],
"assets": [],
"missing_assets": [],
"body": "\n# School Transport Management\n\nBlueBic helps manage complex bus routes and student transportation logistics.\n\n## 1. Defining Routes and Vehicles\n- Go to **Academics > Transportation**.\n- Create **Bus Routes** (e.g., \"Lekki Phase 1 - Route A\").\n- Register your **Vehicles** and assign drivers to them.\n\n## 2. Assigning Students to Routes\nLink students to their respective bus routes for fee assessment and attendance tracking.\n- Open the student profile or the transport module.\n- Select the route and destination point.\n\n\n\n\nTransport fees are automatically calculated based on the student's assigned route and destination.\n\n",
"raw_file": "academics/transport.mdx"
},
"guide-troubleshooting-login": {
"id": "guide-troubleshooting-login",
"title": "Login Troubleshooting and Password Recovery",
"roles": [
"employee",
"student",
"guardian"
],
"permissions": [],
"routes": [],
"components": [],
"assets": [],
"missing_assets": [],
"body": "\n# Login Troubleshooting\n\nIf you are having trouble accessing your BlueBic account, follow these steps.\n\n## Forgotten Password\n1. Click **Forgot Password** on the login page.\n2. Enter your registered email address.\n3. Check your inbox for the reset link (check Spam/Junk folders too).\n\n## Account Locked\nFor security, accounts are locked after 5 failed attempts. Please contact your school administrator to unlock your profile.\n\n\nEnsure your browser is up-to-date and clear your cache if the page is not loading correctly.\n\n",
"raw_file": "auth/troubleshooting.mdx"
},
"guide-batch-management": {
"id": "guide-batch-management",
"title": "Managing Batches and Class Assignments",
"roles": [
"employee"
],
"permissions": [
"batch_control"
],
"routes": [],
"components": [],
"assets": [],
"missing_assets": [],
"body": "\n# Managing Batches and Class Assignments\n\nBatches are the core organizational units in BlueBic, representing a specific arm of a class within an academic session. This guide covers how to create, update, and manage batches, including assigning key roles like Class Teachers.\n\n## Creating a Batch\n\nTo create a new batch, navigate to **Academic > Batches** and click on **New Batch**.\n\n1. **Select Academic Session**: Ensure you are in the correct academic year.\n2. **Choose Course**: Select the class level (e.g., JSS 1).\n3. **Specify Arm**: Enter the arm name (e.g., A, B, Gold, or Blue).\n\n\n\n## Assigning Class Teachers\n\nClass teachers have special permissions to manage students and enter behavioral scores for their specific batch.\n\n1. Open the Batch detail page.\n2. Navigate to the **Staff** or **Roles** tab.\n3. Click **Assign Role** and select **Class Teacher**.\n4. Choose the employee from the list.\n\n## Attendance & Behavioral Scoring\n\nClass teachers are responsible for:\n\n* **Attendance Register**: Marking daily attendance for all students in the batch.\n* **Behavioral Scores**: Entering grades for psychomotor and affective domains (e.g., Punctuality, Neatness) via the **Behavioural Scoresheet**.\n\n\nBehavioral indicators are configured at the school level but applied per batch based on the Course Set settings.\n\n\n## Batch Transfers (Setup)\n\nFor mid-session transitions or setting up new terms, you can use the **Import Setup** tool to transfer subject teachers, students, and assessment structures from a previous batch.\n\n\nDeleting a batch is only possible if it has no active students or subjects associated with it. This is a safety measure to prevent data loss.\n\n",
"raw_file": "batches/management.mdx"
},
"guide-events-calendar": {
"id": "guide-events-calendar",
"title": "Managing the School Calendar and Events",
"roles": [
"employee",
"admin"
],
"permissions": [
"events_management"
],
"routes": [],
"components": [],
"assets": [],
"missing_assets": [],
"body": "\n# School Calendar\n\nKeep parents and staff synchronized with upcoming holidays, parent-teacher meetings, and academic deadlines.\n\n## Adding an Event\n- Navigate to **Events > Calendar**.\n- Click on the target date.\n- Specify whether the event is for the whole school or specific batches.\n\n## Holiday Management\nMark dates as 'School Holidays' to automatically block attendance registers for those days.\n\n\n",
"raw_file": "communication/calendar.mdx"
},
"guide-academic-events": {
"id": "guide-academic-events",
"title": "Planning Special School Events and Meetings",
"roles": [
"employee",
"admin"
],
"permissions": [
"events_management"
],
"routes": [],
"components": [],
"assets": [],
"missing_assets": [],
"body": "\n# Planning School Events\n\nEvent management in BlueBic goes beyond just a calendar entry. It allows for detailed planning and communication.\n\n## Event Types\n- **Parent-Teacher Associations (PTA)**\n- **Sports Inter-house Competitions**\n- **Internal Staff Meetings**\n\n## RSVPs and Invites\nWhen creating an event, you can enable 'RSVP' for guardians. This helps with logistics and catering planning.\n\n\n\n\nAttach the meeting agenda directly to the event so invitees can review it beforehand.\n\n",
"raw_file": "communication/event_planning.mdx"
},
"guide-system-messages": {
"id": "guide-system-messages",
"title": "Sending Announcements and System Messages",
"roles": [
"employee",
"admin"
],
"permissions": [
"messages"
],
"routes": [],
"components": [],
"assets": [],
"missing_assets": [],
"body": "\n# System Messages\n\nCentralize your school communication using BlueBic's messaging and announcement tools.\n\n## Sending an Announcement\nAnnouncements appear as prominent banners on the dashboard of specific users.\n- Go to **Messages > Announcements**.\n- Select target roles (e.g., Doctors, Parents, Staff).\n- Compose and publish.\n\n## Private Messaging\nEmployees can communicate securely with guardians regarding student performance or administrative matters.\n\n\n\n\nUse \"Templates\" for frequently sent messages like fee reminders or holiday notifications.\n\n",
"raw_file": "communication/messages.mdx"
},
"communication-messaging": {
"id": "communication-messaging",
"title": "Messaging & Communication",
"roles": [
"admin",
"employee"
],
"permissions": [
"send_message"
],
"routes": [
"/messages",
"/messages/sms-topups"
],
"components": [
"SendMessageForm",
"MessageView"
],
"assets": [],
"missing_assets": [],
"body": "\n# School-Wide Communication\n\nBlueBic allows you to send bulk messages to **Students**, **Guardians**, and **Staff** via SMS and Email.\n\n## Compose a Message\n\n1. Navigate to **Messages**.\n2. Click **New Message**.\n3. **Select Recipients**:\n - *Students*: Sends to the student's own contact info.\n - *Guardians*: Sends to the parents linked to those students.\n - *Employees*: Internal staff announcements.\n4. **Select Channel**:\n - **Email**: Free, supports Rich Text (Bold, Italic), unlimited length.\n - **SMS**: Costs \"Units\", plain text only, strictly limited character count.\n\n\n\n## SMS Constraints & Top-Ups\n\n### Character Limits\nSMS is expensive and limited.\n- **1 Page**: 160 Characters.\n- **Concatenation**: If you exceed 160, it counts as 2 pages (double cost).\n- **Clean Text**: The system automatically strips formatting (Bold, Colors) from SMS.\n\n### Top-Ups\nTo send SMS, your school must have **SMS Units**.\n1. Navigate to **Messages > SMS Top-Ups**.\n2. View your balance and history.\n3. Contact support to purchase more units.\n\n## Delivery Reports\nYou can track the status of every message sent:\n- **Delivered**: Successfully reached the phone/inbox.\n- **Failed**: Network error or invalid number.\n- **Pending**: Queued by the provider.\n\n> [!TIP]\n> **Urgent info?** Use SMS. Parents read texts instantly.\n> **Newsletters?** Use Email. It's free and better for long content.\n",
"raw_file": "communication/messaging.mdx"
},
"guide-dashboard-overview": {
"id": "guide-dashboard-overview",
"title": "Navigating the BlueBic Dashboard",
"roles": [
"employee",
"student",
"guardian"
],
"permissions": [],
"routes": [],
"components": [],
"assets": [],
"missing_assets": [],
"body": "\n# Dashboard Overview\n\nThe dashboard provides a high-level summary of your school's daily activities.\n\n## Custom Widgets\n- **Student Count**: Live tally of enrolled students.\n- **Attendance Graph**: Weekly trends in attendance.\n- **Fee Collection Summary**: Today's revenue (Accountants only).\n\n## Notification Center\nStay alerted to new messages, pending approvals, or upcoming events via the notification bell in the top header.\n\n\n",
"raw_file": "dashboard/overview.mdx"
},
"guide-staff-attendance": {
"id": "guide-staff-attendance",
"title": "Marking Staff Attendance and Leave Management",
"roles": [
"employee",
"admin"
],
"permissions": [
"staff_management"
],
"routes": [],
"components": [],
"assets": [],
"missing_assets": [],
"body": "\n# Staff Attendance\n\nMonitor employee punctuality and manage leave requests through the integrated staff module.\n\n## Daily Register\nThe register is typically managed by the HR officer or Principal.\n- Go to **Staff > Attendance**.\n- Mark staff as **Present**, **Late**, or **Absent**.\n\n## Leave Requests\nStaff can apply for leave via their portal. \n- Once submitted, the Admin receives a notification.\n- Leaves can be marked as 'Paid' or 'Unpaid'.\n\n\n\n\nStaff attendance trends are often used as a KPI for performance reviews.\n\n",
"raw_file": "employees/attendance.mdx"
},
"guide-staff-onboarding": {
"id": "guide-staff-onboarding",
"title": "Staff Onboarding and Role Assignment",
"roles": [
"employee",
"admin"
],
"permissions": [
"staff_management"
],
"routes": [],
"components": [],
"assets": [],
"missing_assets": [],
"body": "\n# Staff Onboarding\n\nManage your school's workforce by creating employee profiles and assigning appropriate system permissions.\n\n## Adding a Staff Member\n- Navigate to **Staff > All Employees**.\n- Click **Add Employee**.\n- Enter personal details, contact info, and bank account for payroll.\n\n## Role-Based Access Control\nAssigning the right roles is critical for security.\n- **Admin**: Full access.\n- **Accountant**: Finance and fee modules.\n- **Teacher**: Academics and class registers.\n\n\n\n\nEnsure the staff's email address is unique as it serves as their login identifier.\n\n",
"raw_file": "employees/onboarding.mdx"
},
"guide-finance-fees": {
"id": "guide-finance-fees",
"title": "Setting up School Fees and Fee Categories",
"roles": [
"employee",
"accountant"
],
"permissions": [
"finance"
],
"routes": [],
"components": [],
"assets": [],
"missing_assets": [],
"body": "\n# Setting up School Fees\n\nBlueBic's finance module allows you to define flexible fee structures for different classes and student categories.\n\n## 1. Creating Fee Categories\nCategories help group related fee items (e.g., \"Tuition\", \"Bus Services\").\n- Go to **Finance > Fee Categories**.\n- Click **Add Category**.\n- Assign it to specific batches or make it global.\n\n## 2. Defining Fee Items\nItems are the actual charges students pay.\n- Add items like \"Tuition Fee\", \"Library Fee\", or \"Sports Uniform\".\n- Specify the amount and whether it's mandatory.\n\n\n\n\nEach fee item must be linked to a budget head for accounting accuracy.\n\n",
"raw_file": "finance/fees.mdx"
},
"finance-overview": {
"id": "finance-overview",
"title": "Finance & Accounts Overview",
"roles": [
"employee",
"admin",
"bursar"
],
"permissions": [
"view_finance",
"manage_finance"
],
"routes": [
"/finance/transactions",
"/finance/fees"
],
"components": [
"FinanceTransactions",
"FinanceOverviewWidget"
],
"assets": [],
"missing_assets": [],
"body": "\n# Managing School Finances\n\nThe **Finance Module** in BlueBic acts as your school's central ledger. It tracks every kobo of **Income** (School Fees, Grant, Sales) and **Expenditure** (Salaries, Maintenance).\n\n## The Concept: \"The Ledger\"\n\nEvery financial event in BlueBic is a **Transaction**.\nA Transaction usually consists of:\n1. **Amount**: How much money moved.\n2. **Date**: When it happened.\n3. **Reference (`F-XXXX`)**: A unique, auto-generated ID.\n4. **Payment Method**: Cash, Bank Teller, Web Pay, or Wallet.\n\n\n\n## Transaction Types\n\nThere are two main categories of transactions:\n\n### 1. Student Transactions (Fee Payments)\nThese are payments linked directly to a **Student Strategy**.\n- **Example**: \"John Doe paying JSS1 First Term Tuition\".\n- These transactions automatically reduce the student's *Outstanding Balance*.\n- They can be split across multiple fee items (e.g., N5,000 for Tuition, N2,000 for Uniform).\n\n### 2. Custom Transactions (Income & Expenses)\nThese are general school operations not tied to a specific student.\n- **Income**: Grants, Donations, Tuck Shop Sales.\n- **Expense**: Diesel/Fuel, Staff Salaries, Repairs.\n- **Categorization**: You must select a \"Category\" (e.g., \"Utility\", \"Salary\") for reporting.\n\n## Payment Methods\n\nBlueBic supports strict auditing of payment channels:\n- **Cash**: Money handed physically to the bursar.\n- **Bank Teller**: Payments made at the bank; you must record the Teller Number.\n- **Web Pay**: Automated online payments (Paystack/Flutterwave). These are recorded automatically.\n- **Student Wallet**: Deducting from a student's pre-paid deposit.\n\n> [!WARNING]\n> **Reversal Policy**: Deleting a transaction (if you have permission) will strictly reverse its effect. If it was a fee payment, the student's debt will immediately increase again.\n",
"raw_file": "finance/overview.mdx"
},
"guide-finance-payments": {
"id": "guide-finance-payments",
"title": "Collecting Payments and Issuing Receipts",
"roles": [
"employee",
"accountant"
],
"permissions": [
"finance"
],
"routes": [],
"components": [],
"assets": [],
"missing_assets": [],
"body": "\n# Collecting Payments\n\nEfficiently track and manage student payments via bank transfer, cash, or online gateways.\n\n## Payment Collection Workflow\n1. Search for the student in the **Finance > Collect Fee** section.\n2. Select the pending fee items they are paying for.\n3. Enter the amount paid and the payment mode.\n\n## Online Payments (Paystack)\nIf Paystack is enabled, parents can pay directly from their portal, and the system will automatically reconcile the transaction.\n\n\n\n\nAlways verify the transaction reference for bank transfers before confirming in BlueBic.\n\n",
"raw_file": "finance/payments.mdx"
},
"guide-finance-payroll": {
"id": "guide-finance-payroll",
"title": "School Payroll and Staff Salary Management",
"roles": [
"employee",
"accountant"
],
"permissions": [
"payroll_management"
],
"routes": [],
"components": [],
"assets": [],
"missing_assets": [],
"body": "\n# School Payroll\n\nManage staff salaries, deductions, and bonuses with the integrated payroll module.\n\n## Generating Monthly Payroll\n- Go to **Finance > Payroll**.\n- Select the Month and Year.\n- Review the auto-calculated salaries based on staff contracts.\n\n## Managing Deductions\nAdd one-time or recurring deductions (e.g., Pension, Tax, Loans) directly to the staff profile.\n\n\n\n\nStaff can download their monthly payslips from their personal portal once the payroll is marked as 'Disbursed'.\n\n",
"raw_file": "finance/payroll.mdx"
},
"guide-finance-transactions": {
"id": "guide-finance-transactions",
"title": "Auditing Financial Transactions and History",
"roles": [
"employee",
"accountant"
],
"permissions": [
"finance"
],
"routes": [],
"components": [],
"assets": [],
"missing_assets": [],
"body": "\n# Auditing Transactions\n\nBlueBic maintains a tamper-proof audit log of every financial transaction in the system.\n\n## Viewing Transaction History\n- Navigate to **Finance > Transactions**.\n- Use the filters to search by **Date**, **Student Name**, or **Payment Method**.\n\n## Handling Voids and Refunds\nOnly users with specialized accounting roles can void a transaction.\n- Open the transaction details.\n- Provide a mandatory reason for the void.\n- The system will automatically reverse the student's balance.\n\n\nVoided transactions are never deleted; they are marked as 'Cancelled' for auditing purposes.\n\n",
"raw_file": "finance/transactions.mdx"
},
"guide-finance-wallets": {
"id": "guide-finance-wallets",
"title": "Student Wallets and Credit Management",
"roles": [
"employee",
"accountant"
],
"permissions": [
"finance"
],
"routes": [],
"components": [],
"assets": [],
"missing_assets": [],
"body": "\n# Student Wallets\n\nWallets allow parents to pre-fund their children's accounts for miscellaneous expenses like canteen use or book purchases.\n\n## Funding a Wallet\nParents can top up via the portal, or an accountant can record a physical cash deposit in the **Finance > Wallets** section.\n\n## Making Deductions\nWhen a student makes a purchase:\n1. Search for their wallet.\n2. Enter the deduction amount.\n3. The system ensures they have sufficient balance before processing.\n\n\nSet up 'Balance Alerts' to notify parents when a student's wallet falls below a certain threshold.\n\n",
"raw_file": "finance/wallets.mdx"
},
"guide-guardian-management": {
"id": "guide-guardian-management",
"title": "Managing Guardians and Parent Communication",
"roles": [
"employee",
"admission_officer"
],
"permissions": [
"admission"
],
"routes": [],
"components": [],
"assets": [],
"missing_assets": [],
"body": "\n# Managing Guardians\n\nGuardians in BlueBic are central entities that can be linked to multiple siblings across different classes.\n\n## Creating a Guardian\nGuardians can be created during student admission or independently in the **Guardians** module.\n\n1. Navigate to **Guardians > New Guardian**.\n2. Enter contact details (Phone and Email are used for SMS/Email notifications).\n\n## Linking Siblings\nTo link a student to an existing guardian:\n- Open the student's profile.\n- Go to the **Family** tab.\n- Click **Link Guardian** and search by name or phone number.\n\n\n",
"raw_file": "guardians/management.mdx"
},
"guide-settings-branding": {
"id": "guide-settings-branding",
"title": "Customizing School Branding and Visual Identity",
"roles": [
"employee",
"admin"
],
"permissions": [
"settings"
],
"routes": [],
"components": [],
"assets": [],
"missing_assets": [],
"body": "\n# School Branding\n\nBlueBic allows you to tailor the platform's appearance to match your school's unique brand and colors.\n\n## 1. Logo and Favicon\n- Navigate to **Settings > Branding**.\n- **School Logo**: Upload a high-resolution PNG for report cards and receipts.\n- **Favicon**: Upload a small icon for browser tabs.\n\n## 2. Theme Personalization\nYou can customize the accent colors of the PWA to align with your school house colors.\n- Select your **Primary Color**.\n- The system will automatically adjust button gradients and highlights.\n\n\n\n\nBranding changes are instantly reflected across all Student and Guardian portals.\n\n",
"raw_file": "settings/branding.mdx"
},
"guide-settings-grade-scales": {
"id": "guide-settings-grade-scales",
"title": "Configuring Grade Scales and Pass Marks",
"roles": [
"employee",
"admin"
],
"permissions": [
"settings"
],
"routes": [],
"components": [],
"assets": [],
"missing_assets": [],
"body": "\n# Grade Scales\n\nDefine how scores are mapped to letter grades (A, B, C, etc.) and what constitutes a 'Pass' or 'Fail'.\n\n## Setting Range Bounds\n- **A (Excellent)**: 90 - 100\n- **B (Very Good)**: 80 - 89\n- **C (Credit)**: 50 - 79\n\n## Multiple Grade Scales\nYou can define different scales for Nursery, Primary, and Secondary sections to match varying academic standards.\n\n\n\n\nGrade scales are applied at the 'Course Set' level to ensure consistency across all arms of a class.\n\n",
"raw_file": "settings/grade_scales.mdx"
},
"guide-settings-indicators": {
"id": "guide-settings-indicators",
"title": "Configuring Behavioral and Skill Indicators",
"roles": [
"employee",
"admin"
],
"permissions": [
"settings"
],
"routes": [],
"components": [],
"assets": [],
"missing_assets": [],
"body": "\n# Behavioral Indicators\n\nTrack non-academic performance through Affective and Psychomotor indicators.\n\n## Affective Domain\nIncludes character traits such as:\n- Punctuality\n- Honesty\n- Relationship with peers\n\n## Psychomotor Domain\nTracks physical and creative skills:\n- Handwriting\n- Fluency in Speech\n- Sportsmanship\n\n\nThese indicators are scored by the Class Teacher and appear on the final cumulative report card.\n\n",
"raw_file": "settings/indicators.mdx"
},
"guide-inventory-management": {
"id": "guide-inventory-management",
"title": "Managing Inventory Items and Stock Levels",
"roles": [
"employee",
"admin"
],
"permissions": [
"inventory"
],
"routes": [],
"components": [],
"assets": [],
"missing_assets": [],
"body": "\n# Inventory Management\n\nTrack school assets, stationery, and uniforms with the integrated inventory module.\n\n## 1. Inventory Categories\nGroup items like \"Stationery\", \"Furniture\", or \"Laboratory Equipment\".\n\n## 2. Tracking Stock\n- **Stock In**: Record new purchases and incoming supplies.\n- **Stock Out**: Track items distributed to departments or sold to students (e.g., Workbooks).\n\n\n\n\nSet 'Low Stock Alerts' to receive notifications when essential items like chalk or paper are running low.\n\n",
"raw_file": "settings/inventory.mdx"
},
"settings-overview": {
"id": "settings-overview",
"title": "School Configuration & Settings",
"roles": [
"admin"
],
"permissions": [
"manage_settings"
],
"routes": [
"/settings/school-details",
"/settings/classes",
"/settings/academic-sessions"
],
"components": [
"SchoolDetailsForm",
"ClassList"
],
"assets": [],
"missing_assets": [],
"body": "\n# Configuring Your School\n\nThe **Settings** module is the backbone of your BlueBic installation. It defines your school's identity, structure, and academic calendar.\nOnly **Administrators** have access to this area.\n\n## 1. School Details\nNavigate to **Settings > School Details**.\nHere you configure:\n- **School Name & Motto**: Appears on all reports.\n- **Logo**: Upload your crest (PNG/JPG). This will be stamped on Result Sheets and IDs.\n- **Contact Info**: Email and Phone numbers used for SMS/Receipts.\n\n\n\n## 2. Academic Sessions\nBlueBic organizes data by **Session** (e.g., \"2023/2024\") and **Term** (e.g., \"First Term\").\n- **Current Session**: The active session where new data is recorded.\n- **Switching Sessions**: You can view past data by switching the active session in the top-right corner, but you can only *edit* the current session settings here.\n\n## 3. Class Structure\nNavigate to **Settings > Classes**.\nThis is where you define the hierarchy:\n1. **Section**: e.g., \"Secondary\", \"Primary\".\n2. **Class Set**: e.g., \"JSS1\", \"JSS2\".\n3. **Arm/Division**: e.g., \"JSS1 A\", \"JSS1 Gold\".\n\n> [!IMPORTANT]\n> **Naming Convention**: Ensure your class names are consistent (e.g., don't mix \"Year 1\" and \"Primary 1\") to avoid confusion in reports.\n\n\n\n## 4. Subject Names\nDefine the \"Pool\" of subjects available in your school (e.g., \"Mathematics\", \"Civic Education\").\n- Once defined here, they can be assigned to specific classes in the **Academics** module.\n",
"raw_file": "settings/overview.mdx"
},
"guide-school-settings": {
"id": "guide-school-settings",
"title": "Configuring School Profile and Academic Sessions",
"roles": [
"employee",
"admin"
],
"permissions": [
"settings"
],
"routes": [],
"components": [],
"assets": [],
"missing_assets": [],
"body": "\n# School Settings\n\nConfigure the fundamental building blocks of your school's digital identity and academic calendar.\n\n## School Profile\nUpdate your school's name, logo, address, and contact details. This information appears on all official reports and receipts.\n\n## Academic Sessions and Terms\n- Sessions (e.g., 2025/2026) define the academic year.\n- Terms (first, second, third) categorize the scoring periods.\n\n\n\n\nChanging the 'Active Term' will shift the entire system's focus to the new term, affecting attendance and scoresheets.\n\n",
"raw_file": "settings/school_config.mdx"
},
"student-add": {
"id": "student-add",
"title": "Adding a New Student",
"roles": [
"employee",
"admission_officer"
],
"permissions": [
"admission",
"student_control"
],
"routes": [
"/students/add"
],
"components": [
"StudentForm",
"AdmissionWidget"
],
"assets": [],
"missing_assets": [],
"body": "\n# Adding a Student to BlueBic\n\nTo add a new student, you must have the **Admission** or **Student Control** permission.\n\n1. Navigate to the **Students** menu in the sidebar.\n2. Click the **Add Student** button (top right).\n3. **Step 1: Personal Details**: Fill in the name, date of birth, and gender.\n4. **Step 2: Guardian Info**: Link an existing guardian or create a new one.\n\n> [!TIP]\n> **Passport Photos**: Ensure you have the student's passport photo ready on your device. It is required for the ID card generation.\n\n\n\n",
"raw_file": "students/add.mdx"
},
"guide-bulk-student-import": {
"id": "guide-bulk-student-import",
"title": "Bulk Importing Students via Excel",
"roles": [
"employee",
"admission_officer"
],
"permissions": [
"admission"
],
"routes": [],
"components": [],
"assets": [],
"missing_assets": [],
"body": "\n# Bulk Student Import\n\nFor new schools or new academic sessions, manually adding hundreds of students can be tedious. Use the Bulk Import tool to save time.\n\n## The Process\n1. **Download Template**: Get the standard BlueBic Excel template from the **Admission > Bulk Import** page.\n2. **Data Entry**: Fill in student details ensuring mandatory fields (Name, Gender, Batch) are present.\n3. **Upload & Validate**: Upload the file. The system will check for errors or duplicates.\n4. **Confirm**: Once validation passes, click **Import All**.\n\n\n\n\nDo not modify the column headers in the Excel template, as this will break the mapping logic.\n\n",
"raw_file": "students/bulk_import.mdx"
},
"guide-id-card-generation": {
"id": "guide-id-card-generation",
"title": "Generating and Printing Student/Staff ID Cards",
"roles": [
"employee",
"admin"
],
"permissions": [
"admission"
],
"routes": [],
"components": [],
"assets": [],
"missing_assets": [],
"body": "\n# ID Card Generation\n\nProfessional ID cards can be generated directly from BlueBic using the information stored in user profiles.\n\n## Prerequisites\nEnsure all students and staff have:\n1. A uploaded passport photograph.\n2. Correct Batch/Designation assigned.\n3. Valid contact information.\n\n## Printing Workflow\n- Navigate to **Reports > ID Cards**.\n- Select the students or staff members.\n- Choose your **ID Card Template**.\n- Click **Generate & Print**.\n\n\n\n\nAlways verify the 'Preview' to ensure names aren't cut off before sending to a bulk printer.\n\n",
"raw_file": "students/id_cards.mdx"
},
"guide-student-reports": {
"id": "guide-student-reports",
"title": "Student Individual Performance Reports",
"roles": [
"employee",
"guardian",
"student"
],
"permissions": [
"view_score"
],
"routes": [],
"components": [],
"assets": [],
"missing_assets": [],
"body": "\n# Individual Performance Reports\n\nStudents and Guardians can view detailed academic progress reports directly from their portal.\n\n## Accessing the Report\n- Navigate to the **Academics** tab in the mobile or web portal.\n- Select the **Academic Year** and **Term**.\n- Click **View Report Card**.\n\n## Understanding the Layout\n- **Summary**: Attendance stats and average score.\n- **Subject Breakdown**: Scores, grades, and teacher remarks.\n- **Principal's Comment**: Final assessment from the school head.\n\n\n",
"raw_file": "students/performance_reports.mdx"
},
"guide-student-promotion": {
"id": "guide-student-promotion",
"title": "Academic Promotion and Session Roll-over",
"roles": [
"employee",
"admin"
],
"permissions": [
"batch_control"
],
"routes": [],
"components": [],
"assets": [],
"missing_assets": [],
"body": "\n# Student Promotion\n\nAt the end of an academic session, use the Promotion tool to move students to the next class level.\n\n## The Promotion Workflow\n1. Select the current Batch and the target Batch.\n2. Review the final scores for all students.\n3. Select students who passed and click **Promote**.\n\n## Handling Retentions\nStudents who do not meet the pass criteria can be retained in their current class level for the new session.\n\n\nPromotion is a permanent action for the current session. Double-check the target batch before processing.\n\n",
"raw_file": "students/promotion.mdx"
},
"guide-subject-management": {
"id": "guide-subject-management",
"title": "Managing Subjects and Academic Assessments",
"roles": [
"employee"
],
"permissions": [
"subject_master"
],
"routes": [],
"components": [],
"assets": [],
"missing_assets": [],
"body": "\n# Managing Subjects and Academic Assessments\n\nSubjects in BlueBic are assigned to specific batches, allowing for localized grading and teacher assignment. This guide explains how to manage subject delivery and assessment workflows.\n\n## Setting Up Subjects\n\nSubjects are typically created under the **Academic > Subjects** menu. Each subject must be linked to a **Subject Base** (the global definition) and a **Batch**.\n\n* **Is Elective?**: Toggle this if the subject is optional for students.\n* **Max Weekly Classes**: Set the frequency for time-table integration.\n\n## Assigning Subject Teachers\n\nSubject teachers manage the scoresheet and assessments for their specific subject.\n\n1. On the Subject detail page, go to **Assigned Staff**.\n2. Click **Add Teacher** and choose the employee.\n3. You can assign multiple teachers to a single subject if necessary.\n\n\n\n## Managing Assessments\n\nEach subject can have multiple assessment components (e.g., CA 1, CA 2, Exams). \n\n* **Scoresheet**: Use the central scoresheet to enter grades for all registered students.\n* **Weighted Components**: Ensure your assessment weights total 100% for accurate report card generation.\n\n## Elective Subject Registration\n\nFor elective subjects, you must manually register the students who are taking the course.\n\n1. Click on **Elective Registration** in the subject menu.\n2. Select the students from the batch who are enrolled in this subject.\n3. Click **Save Registration**.\n\n\nIf a student is accidentally assigned to an assessment but is not in the batch, use the **Cleanup Unassigned Students** tool in the scoresheet to remove them without affecting actual grades.\n\n\n\nYou cannot delete a subject if it already has recorded assessment scores or registered students.\n\n",
"raw_file": "subjects/management.mdx"
}
}