Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/RigbySawGame/ieeEdu_Wen/llms.txt

Use this file to discover all available pages before exploring further.

Beyond courses, IEE Edu hosts a publication library of books and articles, a configurable homepage hero carousel, and a consultancy intake system. The content management section of the admin panel unifies all of these touchpoints — letting administrators upload resources, update branding assets, respond to consultation leads, and adjust global platform settings from a single area.

Books

The book library supports three categories: Libro (purchasable), Libro en camino (coming soon, always free), and Guía. Each book entry tracks downloads and approved sales. List and create:
GET   /admin/books
POST  /admin/books
Update and delete:
PATCH  /admin/books/{book}
DELETE /admin/books/{book}
Book fields:
FieldTypeNotes
titlestringRequired
categoryenumLibro, Libro en camino, or Guía
authorstringOptional; defaults to IEE for “en camino” books
descriptionstringRequired
pricefloatRequired; 0 for free/coming-soon books
stockintegerRequired when price > 0; null for free books
cover_imagefileRequired on create; JPEG/PNG/WebP, max 2 MB
file_pathfileOptional downloadable file (PDF, DOC, DOCX, ZIP, max 10 MB)
download_urlstringOptional external download URL (used if no file is uploaded)
is_availablebooleanRequired; controls catalog visibility
Book access is not covered by a Premium subscription. Each book requires its own individual payment. Admins approve book payments through the Payments panel, which then records a BookOrder and grants the student download access.

Book Orders

When a book payment is approved, an associated BookOrder record is created to track the fulfillment status. Admins can update that status as they process orders.
GET   /admin/book-orders
PATCH /admin/book-orders/{bookOrder}
The index endpoint returns all book orders, including related user and book information, for review and status updates.

Articles

Articles represent IEE’s media publications — press clippings, research releases, and editorial content. Each article links to a PDF file or an external URL. List and create:
GET   /admin/articles
POST  /admin/articles
Update and delete:
PATCH  /admin/articles/{article}
DELETE /admin/articles/{article}
Article fields:
FieldTypeNotes
titlestringRequired
mediastringRequired; publication or media outlet name
published_atdateRequired
thumbnailfileRequired on create; cover image (JPEG/PNG/WebP, max 2 MB)
file_pathfileOptional PDF upload (max 10 MB); if provided, overrides download_url
download_urlstringRequired; used as the download/read link
Deleting an article removes its associated thumbnail and PDF file from storage.

Banners

Banners populate the homepage hero carousel and other featured sections. Each banner is identified by a section slug and a display order integer. Upserting (create-or-update) is handled by a single POST endpoint — if a banner already exists for the given section + order combination, it is updated in place.
GET  /admin/banners
POST /admin/banners
Banner fields:
FieldTypeNotes
sectionstringRequired; identifies the carousel or section
orderintegerRequired; display position within the section
imagefileOptional; JPEG/PNG/WebP, max 4 MB
headingstringOptional overlay heading text
subheadingstringOptional overlay subheading
button_textstringOptional CTA button label
button_linkstringOptional CTA button URL
positionstringText overlay position (e.g. center, left)
show_textbooleanToggle overlay text visibility
whatsapp_numberstringOptional WhatsApp contact number
contact_emailstringOptional contact email shown on the banner
contact_addressstringOptional physical address

Consultancy Requests

Students and visitors can submit consultation requests through the platform. Admins review and advance each request through a simple status workflow.
GET   /admin/consultancies
PATCH /admin/consultancies/{consultancyRequest}/status
Status values:
ValueMeaning
pendienteNew request, not yet reviewed
en_contactoAdmin has made contact with the requester
cerradoRequest resolved and closed
The index endpoint defaults to hiding cerrado requests to keep the list focused on open items. Pass status=all to see every record. The updateStatus body must include:
{ "status": "en_contacto" }

Company Settings

Global platform settings — site name, contact information, and branding — are managed through the company settings form.
GET   /admin/settings/company
PATCH /admin/settings/company
Changes are applied immediately via SiteSettingsService::update() and are reflected across all Inertia shared data on the next page load.

Subscription Plans

Subscription plan pricing and metadata are stored in the subscription_plans table and cached via PlanPricing. Admins can adjust plan names, prices, and descriptions without a code deploy.
GET   /admin/settings/plans
PATCH /admin/settings/plans/{subscriptionPlan}
The index endpoint returns all plans with their id, slug, name, price, months, period_label, badge, description, features, sort_order, and is_active fields. After any update, the PlanPricing cache is automatically cleared so new prices take effect immediately.

Build docs developers (and LLMs) love