Ticket #29 (assigned enhancement)

Opened 3 years ago

Last modified 2 years ago

better organziation of the API page.

Reported by: kohlhase Owned by: vzholudev
Priority: blocker Milestone: Release v0.2
Component: TRAC Version:
Keywords: Cc:
Blocked By: Blocking:
Due to close: YYYY/MM/DD Include in GanttChart: no
Dependencies: Due to assign: YYYY/MM/DD

Description

I like the way the API (restful) wiki page is organized with explicit links and examples. Here are a couple of improvement suggestions.

BTW, you should have a component TRAC, so that I can direct this kind of ticket there.

So here we go:

  1. you should decrease the itemize level of the examples by one, so that it is visibly under the Method heading.
  2. You may want to number the methods as well.
  3. you might want to chop the page into pieces. Basically each top-level heading should become one page. Then you can keep this page as an overview, adding one or two sentences for each inferior page.
  4. you may want to add use a slot "use-cases" next to example.
  5. now that you have a live TNTBase, you should really replace the localhost URIs with live ones; but keep the examples.

Change History

comment:1 Changed 3 years ago by vzholudev

Agree with everything. Will do soon. I will create a TRAC component in a minute

comment:2 Changed 3 years ago by vzholudev

  • Status changed from new to assigned
  • Component changed from DB XML Accessor library to TRAC
  • Milestone set to Virtual Files

comment:3 Changed 2 years ago by vzholudev

Milestone Virtual Files deleted

comment:4 Changed 2 years ago by vzholudev

  • Milestone set to Release v0.1

comment:5 Changed 2 years ago by vzholudev

  • Milestone changed from Release v0.1 to Release v0.2

Patrtially done, but there is room for improvement

Note: See TracTickets for help on using tickets.