Page MenuHomePhabricator

update documentation of js data model
Closed, ResolvedPublic

Description

We need to update the documentation of our js data model to reflect
reality again.


Version: master
Severity: normal
Whiteboard: u=dev c=frontend p=0

Details

Reference
bz73606

Event Timeline

bzimport raised the priority of this task from to High.Nov 22 2014, 3:54 AM
bzimport set Reference to bz73606.
bzimport added a subscriber: Unknown Object (MLST).

This ticket needs some more specification. I am not sure about what the expected outcome should be as I do not see the need for the ticket to be blocked by the high-level documentation.

The diagram embedded on https://github.com/wmde/WikibaseDataModelJavaScript does reflect the current state of the JS data model and proofs to be very useful already.

After merging https://github.com/wmde/WikibaseDataModelJavaScript/pull/20, it will be possible to generate a proper code documentation with JSDuck.

That should be fair enough regarding JS data model specific documentation.

Lydia_Pintscher removed a subscriber: Unknown Object (MLST).

Yes sounds good to me :)

(marked as blocking to link them together)

Patch is merged. What are the next steps?

Generating the documentation is the next step.

The code documentation is in place. Maybe the task of generating and deploying the documentation should be tracked on T42657. (see also T75987)

JanZerebecki closed this task as Resolved.Jan 14 2015, 5:11 PM