Opened 4 years ago

Closed 3 years ago

Last modified 3 years ago

#1478 closed New feature (fixed)

Add a table of contents & quick description of each API in the API page

Reported by: JulienM Owned by: matt
Priority: normal Milestone: Piwik 1.3
Component: Documentation Keywords:
Cc: Sensitive: no

Description (last modified by matt)

A table of contents with anchor links should be added to the API module list to find content faster.

Also, we should add a short english description of what each API plugin can spefically do. This will make the Analytics API page a bit more digestible.

Change History (6)

comment:1 Changed 4 years ago by matt (mattab)

  • Milestone set to 0 - Piwik 0.6.4
  • Owner set to JulienM

comment:2 Changed 4 years ago by matt (mattab)

  • Milestone changed from 0 - Piwik 0.6.5 to Features requests - after Piwik 1.0

comment:3 Changed 3 years ago by matt (mattab)

  • Component changed from UI (templates, javascript) to Documentation
  • Description modified (diff)
  • Milestone changed from Feature requests to 1.3 - Piwik 1.3
  • Owner changed from JulienM to matt
  • Priority changed from low to normal
  • Summary changed from Add a table of contents in API module listAllAPI action to Add a table of contents & quick description of each API in the API page

comment:4 Changed 3 years ago by matt (mattab)

  • Description modified (diff)

comment:5 Changed 3 years ago by matt (mattab)

  • Resolution set to fixed
  • Status changed from new to closed

(In [4448]) Fixes #1478

that's why it's pretty important :)

  • Adding table of contents in the API Page

comment:6 Changed 3 years ago by matt (mattab)

(In [4454]) Refs #1478 linking to existing doc pages from the API descriptions

Note: See TracTickets for help on using tickets.