Improved documentation structure - awesto/django-shop GitHub Wiki
Refactor Documentation
Starting point for a better documentation structure. Proposal from @racitup: It also really needs annotating with change history, especially settings (e.g. "Changed in v0.10.1").
Architecture
- Description of Django, CMS, admin, Angular, bootstrap, SASS, Haystack & DRF integration
- Features
- Exclusions/ ToDo list (link to reserved github issue number?)
- Compatibility (python, django, CMS, DRF, etc..)
Required component installation & what they're used for
- python
- node / npm
- other (redis & elasticsearch?)
Database integration
- Migrations
- Fixtures - items to include all CMS plugins & CMS shop pages (i.e. search, watch-list, cart, checkout, etc..)
Minimum requirements
- Settings
- URLs 3a. Attaching CMS pages to Views 3b. Attaching DRF Views to URLs
- Styling
Customisation
- Models & admin
- Product Categories
- Overriding Templates & Styling
- Modifiers
- Serializers
- Search
Known external plugins (& degree of recommendation) e.g. Paypal, currencies, modifiers.. If you let me know where the best place to put it is, I may even be able to contribute a draft!