Pi Documentation Team

Jump to bottom Edit New page

Taiwen Jiang 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 Documentation List

Framework
- Introduction
- Pi VI [Achieved]
- Localization
  - System
  - Widget
  - Page
- Pi Flow Chart: by jixingyu [Underway]
Module development
- Best Practices
  - Coding Standards [Achieved]
  - Database Schema [Achieved]
  - Code Review [Achieved]
  - Pi Security [Achieved]
- Development documentation
  - Module Workflow [Achieved]
  - Module Structure [Achieved]
  - Kernel APIs [Pending]
  - Configuration [Pending]
  - Authorization [Pending]
  - Custom setup [Pending]
  - Route [Pending]
  - I18n [Pending]
  - Pagination [Pending]
  - Session [Pending]
  - Parameters [Pending]
  - Database [Pending]
  - Form [Pending]
  - Theme Structure [Pending]
  - Theme Helpers [Pending]
  - Quick Starting with Pi Engine: by linzongshu [Underway]
  - Introduction of tables of Pi Engine: by linzongshu [Underway]
  - File Upload
  - File Download
  - Kernel APIs
    - Event
    - File
    - Log
    - Mail
    - Markup
    - Tag
    - Url
    - User
  - Custom Setup -- resources setup
  - Configuration of var/config folder
  - Oauth
- Development Tutorials
  - Introduction and Setup [Untranslated]
  - Module Design [Untranslated]
  - Form Generation and Validation [Untranslated]
  - Database Operation [Untranslated]
  - Theme and Block [Untranslated]
  - Navigation and Custom Navigation [Untranslated]
  - Custom Route [Untranslated]
  - Authentication Management [Untranslated]
  - Others (APIs/Localization/Updating/Cache) [Untranslated]
  - Pi Engine Mechanism [Untranslated]
Front-end development
- Frontend summary [Untranslated]
- Theme
  - Concept and compose [Untranslated]
  - File structor and file explain [Untranslated]
  - Step by step
  - Advanced [Untranslated]
- Module
  - Concept and compose [Untranslated]
  - File structor and file explain [Untranslated]
  - Step by step
  - Advanced [Untranslated]
- Standard
  - css [Untranslated]
  - js [Untranslated]
  - html [Untranslated]
  - phtml [Untranslated]
- API [Untranslated]
- Backbone
  - Form validate demo [Untranslated]
User manual
- Installation: by linzongshu [Underway]
- Deployment [Achieved]
- Nginx Deployment [Achieved]
- Nginx Virtual Host [Achieved]
- Module Installation
- Theme Installation
- Navigation Setup
- Permission Configuration
- Asset Publishing and Cache Flushing
- Module Configuration
- page Dressing up
  - Creating blocks
  - Creating pages
  - Dressing up

Wishes Pi Documentation list