Skip to content

Commit 86c67c7

Browse files
SmilefounderSmilefounder
committed
upd page structure follow persona
1 parent 386521b commit 86c67c7

File tree

8 files changed

+1054
-49
lines changed

8 files changed

+1054
-49
lines changed

‎docs/admin-guide.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+

‎docs/content-editor-guide.md‎

Lines changed: 173 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,173 @@
1+
---
2+
id: content-editor-guide
3+
title: Content Editor's Guide
4+
sidebar_position: 2
5+
---
6+
7+
# Content Editor's Guide to Mixcore
8+
9+
This guide is designed for content creators, editors, and managers who use Mixcore to publish and manage digital content.
10+
11+
## What You'll Learn
12+
13+
- How to navigate the Mixcore content management interface
14+
- Best practices for creating and organizing content
15+
- How to work with media files and assets
16+
- Content publishing workflows
17+
- SEO optimization for your content
18+
19+
## Getting Started with the Editor Interface
20+
21+
### Logging In
22+
23+
1. Navigate to your Mixcore site's admin area (`your-site.com/portal`)
24+
2. Enter your username and password
25+
3. You'll be taken to the Mixcore dashboard
26+
27+
### Understanding the Dashboard
28+
29+
The dashboard provides quick access to:
30+
31+
- Recent content you've edited
32+
- Content awaiting review/publication
33+
- Site statistics and analytics
34+
- Quick-create buttons for common content types
35+
36+
## Creating and Managing Content
37+
38+
### Posts
39+
40+
Posts are typically used for blog entries, news articles, or other date-based content. See [Writing Posts](basic-usage-writing-posts) for detailed instructions on:
41+
42+
- Creating a new post
43+
- Using the rich text editor
44+
- Adding images and media
45+
- Setting categories and tags
46+
- Scheduling publication
47+
48+
### Pages
49+
50+
Pages are for static, timeless content like "About Us" or "Contact" pages. The [Page Creation Guide](basic-usage-page) covers:
51+
52+
- Creating and organizing pages
53+
- Parent-child page relationships
54+
- Page templates and layouts
55+
- Special page types
56+
57+
### Working with Media
58+
59+
The [Media Library](basic-usage-media) allows you to:
60+
61+
- Upload images, videos, and documents
62+
- Organize media into collections
63+
- Edit images (crop, resize, etc.)
64+
- Insert media into your content
65+
- Manage media metadata
66+
67+
### Categories and Tags
68+
69+
Properly organizing your content makes it easier for visitors to find:
70+
71+
- [Categories](basic-usage-category) for broad groupings
72+
- [Tags](basic-usage-tag) for more specific classifications
73+
- Building a logical taxonomy
74+
75+
## Content Workflow
76+
77+
### Draft to Publication
78+
79+
A typical content workflow includes:
80+
81+
1. **Creating a draft**: Initial content creation
82+
2. **Revision**: Editing and refining
83+
3. **Review**: Editorial or peer review
84+
4. **Publishing**: Making the content live
85+
5. **Updates**: Maintaining content over time
86+
87+
### Scheduling Content
88+
89+
Plan your content calendar:
90+
91+
- Schedule posts for future publication
92+
- Set expiration dates for time-sensitive content
93+
- Manage recurring content updates
94+
95+
### Collaboration
96+
97+
Work effectively with your team:
98+
99+
- Content assignment and ownership
100+
- Editorial review process
101+
- Comment and feedback systems
102+
- Version history and revisions
103+
104+
## Content Optimization
105+
106+
### SEO Best Practices
107+
108+
Optimize your content for search engines:
109+
110+
- Crafting effective titles and descriptions
111+
- Keyword research and implementation
112+
- Internal linking strategies
113+
- Image alt text and accessibility
114+
115+
### Readability
116+
117+
Create content that's easy to consume:
118+
119+
- Writing for the web (scannable content)
120+
- Using headings and subheadings
121+
- Formatting for mobile readers
122+
- Accessibility considerations
123+
124+
## Advanced Content Features
125+
126+
### Embedding Media
127+
128+
Enhance your content with:
129+
130+
- Videos from YouTube, Vimeo, etc.
131+
- Social media posts
132+
- Interactive elements
133+
- Maps and location data
134+
135+
### Custom Content Types
136+
137+
Beyond standard posts and pages:
138+
139+
- Products
140+
- Events
141+
- Team members
142+
- Testimonials
143+
- Case studies
144+
145+
## Analyzing Content Performance
146+
147+
Use analytics to improve your content:
148+
149+
- Page views and engagement metrics
150+
- Social sharing statistics
151+
- Conversion tracking
152+
- A/B testing content variations
153+
154+
## Tips and Best Practices
155+
156+
- Create an editorial calendar
157+
- Maintain consistent voice and style
158+
- Use templates for recurring content types
159+
- Regularly audit and update existing content
160+
- Back up important content before major changes
161+
162+
## Common Questions and Troubleshooting
163+
164+
- What to do if the editor isn't working
165+
- Recovering unsaved content
166+
- Fixing broken images or links
167+
- Getting help with complex layouts
168+
169+
## Further Resources
170+
171+
- [Content Strategy Templates](https://github.com/orgs/mixcore/discussions)
172+
- [Editorial Style Guide Examples](https://github.com/orgs/mixcore/discussions)
173+
- [Community Content Forums](https://github.com/orgs/mixcore/discussions)

‎docs/dev-getting-started.md‎

Lines changed: 62 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,19 @@
11
---
22
id: dev-getting-started
3-
title: Getting Started for Developers
3+
title: Developer Guide
44
---
55

6-
# Developer Guide
6+
# Developer Guide for Mixcore
77

8-
This guide will help you set up your development environment and understand Mixcore's architecture.
8+
This guide is designed specifically for developers who want to build applications, extend functionality, or contribute to Mixcore.
9+
10+
## What You'll Learn
11+
12+
- Setting up a development environment
13+
- Understanding Mixcore's architecture
14+
- Working with the API
15+
- Creating custom modules and features
16+
- Best practices for development
917

1018
## Development Environment Setup
1119

@@ -15,6 +23,7 @@ This guide will help you set up your development environment and understand Mixc
1523
- [Docker](https://www.docker.com/get-started) and [Docker Compose](https://docs.docker.com/compose/install/) (recommended)
1624
- A code editor like [Visual Studio Code](https://code.visualstudio.com/) or [Visual Studio](https://visualstudio.microsoft.com/)
1725
- [Git](https://git-scm.com/)
26+
- Basic knowledge of C#, ASP.NET Core, and web development
1827

1928
### Repository Structure
2029

@@ -35,7 +44,7 @@ mixcore/mix.core/
3544
└─ cloud/ # Cloud deployment templates
3645
```
3746

38-
## Getting Started
47+
## Quick Start
3948

4049
### Option 1: Docker Development (Recommended)
4150

@@ -131,12 +140,38 @@ Mixcore follows API-first design principles with both REST and GraphQL endpoints
131140

132141
- API endpoints are documented using Swagger/OpenAPI
133142
- Access the API documentation at `/swagger` when running locally
143+
- Authentication uses JWT tokens
144+
145+
Example API request with authentication:
146+
147+
```csharp
148+
using var client = new HttpClient();
149+
client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", token);
150+
var response = await client.GetAsync("https://api.example.com/api/v2/posts");
151+
var content = await response.Content.ReadAsStringAsync();
152+
```
134153

135154
### GraphQL
136155

137156
- GraphQL schema provides flexible data querying
138157
- Access the GraphQL playground at `/graphql` when running locally
139158

159+
Example GraphQL query:
160+
161+
```graphql
162+
query {
163+
posts(take: 10, skip: 0) {
164+
id
165+
title
166+
content
167+
author {
168+
id
169+
name
170+
}
171+
}
172+
}
173+
```
174+
140175
## Frontend Development
141176

142177
The admin portal uses modern web technologies:
@@ -159,11 +194,33 @@ npm install
159194
npm run dev
160195
```
161196

197+
## Creating Custom Modules
198+
199+
Mixcore allows developers to create custom modules that extend functionality. A basic module structure includes:
200+
201+
1. **Controller**: Handles HTTP requests
202+
2. **Models**: Defines data structure
203+
3. **Views**: Defines UI components
204+
4. **Services**: Implements business logic
205+
206+
For a detailed guide on creating custom modules, see [Module Development](https://github.com/mixcore/mix.core/wiki/Development/Module-Development).
207+
208+
## Best Practices
209+
210+
- Follow the [C# Coding Conventions](https://docs.microsoft.com/en-us/dotnet/csharp/fundamentals/coding-style/coding-conventions)
211+
- Write unit tests for all new features
212+
- Document your code with XML comments
213+
- Use dependency injection for services
214+
- Follow the repository pattern for data access
215+
- Use async/await for all I/O operations
216+
162217
## Learn More
163218

164219
For more detailed information, see these specific developer guides:
165220

166221
- [Architecture Overview](https://github.com/mixcore/mix.core/wiki/Architecture/Overview)
167222
- [Module Development](https://github.com/mixcore/mix.core/wiki/Development/Module-Development)
168223
- [API Development](https://github.com/mixcore/mix.core/wiki/Development/API-Development)
169-
- [Testing](https://github.com/mixcore/mix.core/wiki/Development/Testing)
224+
- [Testing](https://github.com/mixcore/mix.core/wiki/Development/Testing)
225+
- [Authentication Workflow](dev-login-workflow)
226+
- [Cryptography](dev-cryptography)

0 commit comments

Comments
 (0)