Document front-end code inline and generate public docs
Closed, ResolvedPublic
Actions

Assigned To

Authored By

	• JGirault
	Jul 13 2016, 2:01 AM

Description

Scope:

Out of scope:

Add CI automatic generation/publication on doc.wikimedia.org (See https://www.mediawiki.org/wiki/Continuous_integration/Documentation_generation)
Document - on mediawiki - each resource (See "draft"/initial version: https://www.mediawiki.org/wiki/Help:Extension:Kartographer/Developer_guide)
Add basic code examples - on mediawiki - to show how to use the public APIs directly.
- Fix or remove the code examples currently inline with the code.
Document - on mediawiki - with more details how the Wikivoyage implementation work.

	Subject	Repo	Branch	Lines +/-
	Add front-end documentation inline and generate public docs with jsduck.	mediawiki/extensions/Kartographer	master	+380 -79

Status	Assigned	Task
Resolved	• JGirault	T140203 Document front-end code inline and generate public docs
Resolved	• JGirault	T138054 Document how to use maps directly from JavaScript
Resolved	MaxSem	T140657 Automatically generate and publish JS doc on doc.wikimedia.org

Change 298686 had a related patch set uploaded (by JGirault):
Add front-end documentation inline and generate public docs with jsduck.

Change 298686 merged by jenkins-bot:
Add front-end documentation inline and generate public docs with jsduck.