bitovi / bitovi/training

How to document components and models.

Open
#2 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
19
Forks
4
PR merge metrics
No merged PRs in 30d

Description

It'd be nice to have a recipe on the documentjs way™ to document Components and Models.

In one of our projects for example, we used the following structure for a Model (it seems `@constructor` is deprecated, since it's no longer available in the docs).

``` javascript
/**
* @page Product
* @group Product.static 0 static
* @group Product.list 1 List
* @group Product.instance 2 instance
*
* @constructor Product
* @inherits can.Model
* @parent models
* @description
* ......
**/
```

a component would look like:

``` javascript
/**
* @constructor ProductItem
* @parent components
* @group ProductItemViewModel 0 ViewModel
* @description ........
**/
```

The DocumentJS examples uses an interesting [approach](https://github.com/bitovi/documentjs/blob/f379449f4c02e2c553f749c9efc7bc247066ea2f/examples/simple/components/tabs.js#L3-L9) maybe we can come up with a more detailed example.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by reviewing the issue's Model and component annotation examples and the referenced DocumentJS tabs.js example. Done means proposing a detailed DocumentJS recipe that explains how to document Components and Models, including representative examples and current annotation usage.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.