This repository was archived by the owner on Sep 16, 2021. It is now read-only.
This repository was archived by the owner on Sep 16, 2021. It is now read-only.
Rewriting bundle docs: Blog #262
Closed
Description
The bundle docs need to get updated after the refactoring before RC1. While rewritting, make sure you fix the following things (not everything has to be fixed in the same PR):
- classes - Make sure all classes have correct names and namespaces
- structure [Easy Pick] - Make sure all bundle docs contain the correct structure
- examples [Easy Pick] - Make sure all examples work, containing all needed use statements, adding missing formats, etc.
- standards - Make sure the docs follow the doc standards
- reference config - Make sure all configuration is moved to a
reference/configuration
article and make sure the configuration is up to date - understandable [Easy Pick] - None of the introduction articles must require more knowledge than a user knows after reading the core Symfony2 book.
- advanced topics - Make sure all advanced topics (things that require more knowledge or are not relevant at first) are moved to other articles in the bundle docs (following the structure)
- features - Make sure all features are documented
- text [Easy Pick] - Make sure the text is correct, fix typos, etc.
Classes? | Structure? Easy Pick |
Examples? Easy Pick |
Standards? | Reference Config? | Understandable? Easy Pick |
Advanced topics? | Features? | Text? Easy Pick |
|
---|---|---|---|---|---|---|---|---|---|
SimpleCms | DONE | DONE | DONE | DONE | DONE | DONE | DONE | DONE | DONE |
Create | DONE | DONE | DONE | DONE | DONE | DONE | DONE | DONE | |
Block | DONE | DONE | DONE | DONE | DONE | DONE | DONE | DONE | DONE |
TreeBrowser | DONE | DONE | DONE | DONE | DONE | DONE | DONE | DONE | DONE |
Blog | @dantleech | - | - | - | - | - | - | - | - |
Search | DONE | DONE | DONE | DONE | DONE | DONE | DONE | DONE | |
Media | DONE | DONE | DONE | DONE | DONE | DONE | DONE | DONE | |
Content | DONE | DONE | DONE | DONE | DONE | DONE | DONE | DONE | DONE |
Menu | DONE | DONE | DONE | DONE | DONE | DONE | DONE | DONE | DONE |
Core | DONE | DONE | DONE | DONE | DONE | DONE | DONE | DONE | DONE |
Routing | DONE | DONE | DONE | DONE | DONE | DONE | DONE | DONE | DONE |
RoutingAuto | DONE | DONE | DONE | DONE | DONE | DONE | DONE | DONE | DONE |
When a bundle is all fine, be sure to check the DOC column on the Roadmap as well.