Vuese Migration

Prolog

A UI component library without a good documentation is worth almost nothing. Up until today Fundamental Vue's API documentation is a result of a manually managed JSON file. This JSON file contains information about all of our components (their props, events, slots, …). Maintaining this JSON file is error prone and does not make fun. Going forward we need something better.

Several different documentation-related projects have been evaluated and Vuese seems to fit our needs to best.

Vuese has already been integrated in Fundamental Vue's documentation app – in parallel to the current manually managed API documentation. You can see generated documentation by clicking on the API menu item in the side navigation.

How we will get there

You will notice that the documentation is not perfect. Slots/Props/Events are not described in detail for example.

Thus we have to annotate our code according to Vuese's requirements in order for the new API documentation to become better.

There are already issues for all of our components that need to be migrated.

Using the current Integration

Everytime you run

$ yarn serve

the API documentation is re-generated. Let's assume you have migrated a component over to Vuese you should check your work locally by running yarn serve and look at the API documentation.

Making the Switch

Once we are satisfied with the quality of the automatically generated documentation we can delete the old one and make the automatically generated documentation the primary source.