FLUID-5635: Improve grouping of Infusion docs

Metadata

Source
FLUID-5635
Type
Task
Priority
Critical
Status
Closed
Resolution
Fixed
Assignee
Antranig Basman
Reporter
Anastasia Cheetham
Created
2015-04-20T09:53:19.336-0400
Updated
2022-03-14T12:35:34.408-0400
Versions
N/A
Fixed Versions
N/A
Component
  1. Tech. Documentation

Description

Antranig made the following suggestions for grouping the Infusion documentation table of contents:
The current split of some material into "Infusion" and others into "API" doesn't make too much sense. Certainly whatever top-level grouping we have, material such as "ChangeApplier API" should go together with "Events", "IoC", "Framework API", etc.

I suggest that we have one area called "Infusion" or "Framework" which includes

  • everything currently in "Infusion", plus ChangeApplier API, Framework API, DOM Binder API

Another area called "Components" which includes

  • everything else currently in API - that is, everything from "Inline Edit" down to "Table of Contents".

I suggest we do away with the top-level name "API" since we don't really believe in having APIs anyway.

We should either put "Preferences Framework" in a top-level grouping of its own, or else at the bottom of the "Framework" area or the top of the "Components" area to emphasise that it lives at a special level of abstraction - it is less abstract than all the rest of the "framework", but more abstract than any component.

Comments

  • Anastasia Cheetham commented 2015-12-10T11:07:23.956-0500

    @@Antranig Basman, the documentation table of contents has been reworked a fair amount recently. Could you re-examine this issue, and either a) update it with ideas for further improvement, or b) close it if you think it's fine now.

  • Justin Obara commented 2022-03-14T12:35:34.352-0400

    Closed as per Anastasia's comments. It appears that the restructuring has taken place.