Creating Persona-Based Landing Pages
To improve the user experience for different types of Mixcore users, we've created role-specific landing pages. This guide explains how to implement and maintain these persona-based landing pages.
Overview
Mixcore documentation is now organized around key personas:
- Content Editors: People who create and manage content
- Administrators: People who set up and maintain Mixcore installations
- Developers: People who build custom solutions with Mixcore
- Theme Designers: People who create and customize visual themes
- DevOps Engineers: People who deploy and maintain Mixcore infrastructure
Each persona has a dedicated landing page that serves as a starting point for their specific documentation needs.
Landing Page Structure
Each persona landing page should include:
- Introduction: Brief explanation of the role and responsibilities
- Getting Started: Initial steps for this persona
- Key Tasks: Common tasks performed by this persona
- Learning Path: Suggested reading order for in-depth learning
- Resources: Tools, references, and community resources
Implementation Guide
Step 1: Create the Landing Page
Create a new Markdown file in the docs/docs/
directory:
touch docs/docs/your-persona-guide.md
Step 2: Add Frontmatter
Include metadata at the top of the file:
---
id: your-persona-guide
title: Your Persona's Guide
sidebar_position: X
---
Step 3: Structure the Content
Follow this template:
# [Persona]'s Guide to Mixcore
Brief introduction to the persona's role with Mixcore.
## What You'll Learn
- Key skill/concept 1
- Key skill/concept 2
- Key skill/concept 3
## Getting Started
Quick-start information for this persona.
## Key Tasks
List and briefly describe common tasks.
## Learning Path
Suggested documentation reading order.
## Resources
Links to useful tools and resources.
Step 4: Add to Sidebar
Update sidebars.ts
to include the landing page at the top of the respective persona category.
Example Landing Pages
We've created the following persona-specific landing pages:
- Content Editor's Guide
- Administrator's Guide
- Developer's Guide
- Theme Designer's Guide
- DevOps Engineer's Guide
Maintaining the Landing Pages
To keep landing pages relevant:
- Review regularly: Update as features change
- Gather feedback: Ask users from each persona if the landing page meets their needs
- Monitor analytics: Track which sections users engage with most
- Keep links current: Ensure all linked documents exist and are relevant
Best Practices
- Focus on tasks: Organize by what users want to accomplish, not by features
- Use simple language: Avoid jargon specific to other personas
- Provide context: Explain why tasks matter, not just how to do them
- Include visual aids: Screenshots or diagrams where helpful
- Link generously: Connect to relevant detailed documentation
By maintaining well-structured persona landing pages, you can significantly improve the documentation experience for all Mixcore users.