Pi Documentation Team

Jump to bottom Edit New page

linzongshu edited this page Jul 2, 2013 · 23 revisions

Pi Doc Team

Guide to Doc Team

How to contribute to Pi Documentation
How to translate a document
...

Pi Wiki Structure

Framework
- Introduction
  - Pi Project
  - Pi Team
  - Pi VI
Module development
- Best Practices
  - Coding Standards
  - Database Schema
  - Code Review
  - Pi Security
- Development documentation
  - Module Workflow
  - Module Structure
  - Kernel APIs
  - Configuration
  - Authorization
  - Custom setup
  - Route
  - I18n
  - Pagination
  - Session
  - Parameters
  - Database
  - Form
  - Theme Structure
  - Theme Helpers
- Development Tutorials
  - Introduction and Setup
  - Module Design
  - Form Generation and Validation
  - Database Operation
  - Theme and Block
  - Navigation and Custom Navigation
  - Custom Route
  - Authentication Management
  - Others (APIs/Localization/Updating/Cache)
  - Pi Engine Mechanism
Front-end development
- Theme
- Module
- Standard
- API
- Backbone
User manual
- Deployment
- Nginx Deployment
- Nginx Virtual Host

Pi Documentation TODO list

Framework TODO: by linzongshu
- Quick Starting with Pi Engine: by linzongshu
- Introduction of tables of Pi Engine: by linzongshu
- File Upload
- File Download
- Kernel APIs
  - Event
  - File
  - Log
  - Mail
  - Markup
  - Tag
  - Url
  - User
- Custom Setup -- resources setup
- Configuration of var/config folder
- Oauth
Front-end TODO: by @sexnothing
- Theme step by step: by sexnothing
- Module step by step
Translation TODO: by @lavenderli
- Installation: by linzongshu
- Frontend summary
- Theme
  - Concept and compose
  - File structure and file explain
  - Theme Advanced
- Module
  - Concept and compose
  - File structure and file explain
  - Advanced
- Standard
  - css
  - js
  - html
  - phtml
- API
- Backbone
  - Form validate demo