Create general usage docs

Description

  • syntax

  • arguments

  • installation

Activity

Show:
Brad Wood
August 14, 2014, 11:25 PM
Edited

The new widget doesn't seem to work at all.

  • It errors when I use the page preview button (Error translating widget: No matching Method/Function for String.getContentID() found)

  • The built-in widget preview doesn't match how it actually renders on the page

  • It also shows all pages in the site even if I pass in a content slug.

  • The pages are all out of order and not nested properly

  • The current page doesn't show in the list, but instead there is "no sub pages" text there.

All that aside, I don't want to have to manually add this to every page of documentation. Should I just create a documentation layout like we did on the gocontentbox.org site? This actually seems like it might be a good use of JSTree. The nice thing about JSTree is it can take an unordered list and format it which would be perfect.

Brad Wood
August 15, 2014, 11:04 PM
Edited

A decent start for our usage docs is on stage. There's still couple things to iron out.

  • Links in the TOC don't work. They lose the path_info and redirect to the home page.

  • Need to create a layout for documentation that shows child pages. I'd like to always have all the options there in the nav regardless of what child page you're on. We'll need to figure out how to make it dynamic so it works under "docs/current" as well as any future parents we might clone such as "docs/1.2.4".

Luis Majano
August 16, 2014, 2:17 AM

Thanks Brad, will review

Luis Majano
August 18, 2014, 10:38 PM

Update the site with a new documentation layout, migrate the wiki TOC JS from the contentbox site and update the columns to a two column layout.

Luis Majano
September 16, 2014, 11:35 PM
Edited

Brad,

Can you please update the usage docs to include two new sections please:

  • Package Management

  • Recipes

Especially package management needs to be done ASAP if we want users to start using it.
Thanks

Fixed

Assignee

Brad Wood

Reporter

Brad Wood

Labels

None

Affects versions

None

Fix versions

Time tracking

0m

Time remaining

2h

Priority

Major

Components