doc icon indicating copy to clipboard operation
doc copied to clipboard

v3 initial docs

Open tjwebb opened this issue 8 years ago • 2 comments

  • [x] 0. Start
  • [x] 1. Build
    • [x] Controller
    • [x] Service
    • [x] Model
    • [x] Resolver
    • [x] Policy
  • [x] 2. Configure
    • [x] main
    • [x] log
    • [x] routes
    • [x] stores
    • [x] i18n
    • [x] web
  • [ ] 3. Test
    • [ ] Unit Testing
    • [ ] Integration Testing
  • [ ] 4. Debug
  • [ ] 5. Deploy
    • [ ] Requirements
    • [ ] Providers
    • [ ] Sessions
    • [ ] Security
    • [ ] Scaling
  • [ ] 6. Extend
    • [ ] Trailpack
    • [ ] Re-usable Services
    • [ ] Server-Side Rendering
      • [ ] React.js
      • [ ] Angular 2
    • [ ] User Management
      • [ ] Authentication
      • [ ] Permissions
  • [ ] 7. Upgrade
    • [ ] Application
    • [ ] Trailpack
  • [x] 8. Reference
    • [x] Trails API
    • [x] Trailpack API
    • [x] Controller
    • [x] Service
    • [x] Model
    • [x] Resolver
    • [x] Policy
    • [x] Design Theory
  • [x] 9. Support

tjwebb avatar Feb 13 '17 05:02 tjwebb

Nice plan @tjwebb! Love it ! One thing witch is missing for me is websockets/realtime :) and maybe simple view templating like pug/ejs/handlebar...

Did we keep the fact that we create the doc on each trailpack and then build the full doc with them ?

jaumard avatar Feb 13 '17 06:02 jaumard

One thing witch is missing for me is websockets/realtime :) and maybe simple view templating like pug/ejs/handlebar...

I think realtime should be under the "Guides" section, and we can add templating in the "Server-Side Rendering" section

Did we keep the fact that we create the doc on each trailpack and then build the full doc with them?

For some central Trailpacks (e.g. router) we should maintain the website docs in this repository. Their respective github pages will have docs as well, but we may want to format these differently, etc.

My plan is to knock out the rest of the "Configuration" section today, and then probably spend the rest of this week on "Concepts". My goal is to organize the docs exactly as I'd want them to appear on the website, and use something like https://github.com/rexxars/react-markdown to render the markdown.

tjwebb avatar Feb 13 '17 18:02 tjwebb