Skip to content

[WIP] Documentation update #128

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 11 commits into from
Closed

[WIP] Documentation update #128

wants to merge 11 commits into from

Conversation

ioleo
Copy link
Member

@ioleo ioleo commented Apr 10, 2015

This PR is a work in progress. The goal is to completely rewrite all the documentation.

  • update README
  • bootstrap new documentation structure
  • complete Installation section
  • complete Getting started section
  • complete How does this work? section
  • complete Configuration section
  • complete Customization section
  • complete Cookbook section
  • create "Showcase" page with screenshots of demo project on AdminLTE v2 theme
  • remember to fix Fix doc #120

Quick draft:

1] Installation

Bundle installation notes.

2] Getting started

Quick guide how to get started.

  • assumed knowledge (how to create bundles, models/entities, links to symfony2 doc)
  • create admin generator in existing bundle
  • create new bundle with admin generator

3] How does this work?

  • admingenerator route
  • generated "base" controllers and templates
  • basic configuration to control built-in features
  • extending base files for advanced customization

4] Configuration

  • configuration reference for all builders List/Show/New/Edit/Actions/Excel

5] Customization

  • how to customize forms/filters/view templates

6] Cookbook

  • recipies for common problems, eg. use FormExtensionsBundle, use KnpMenuBundle, non-standard namespace, etc

Fixes: #10, #11, #12, #13, #14, #15, #16, #17, #18, #21.

@ioleo ioleo mentioned this pull request Apr 10, 2015
@bobvandevijver
Copy link
Member

👍 for updating the docs!

@bobvandevijver
Copy link
Member

Closed in favor of #223.

@bobvandevijver bobvandevijver mentioned this pull request Jan 4, 2016
20 tasks
@ioleo
Copy link
Member Author

ioleo commented Jan 4, 2016

@bobvandevijver can the branch be safely deleted?

@bobvandevijver
Copy link
Member

Lets keep it for now, I've added it to the to-do list of #223.

@sescandell sescandell deleted the update-readme branch February 6, 2016 21:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Fix doc Document list builder features
3 participants