statgen / locuszoom

A Javascript/d3 embeddable plugin for interactively visualizing statistical genetic data from customizable sources.
https://statgen.github.io/locuszoom/
MIT License
156 stars 29 forks source link

Port all documentation to JSDoc #231

Closed abought closed 3 years ago

abought commented 3 years ago

Refs #186

The current documentation is a wiki, which is not tied to a specific version, and is updated by hand. It omits many layout options and is cumbersome to keep accurate/up to date. Some of the wiki info reflects features that were never fully implemented or removed, confusing users mightily.

We have been building JSDoc comments into the codebase to prepare for a transition to machine-generated API docs. Build, test, and expose those docs to replace the wiki, with improved information about layout options.

New things to document:

abought commented 3 years ago

Core updates complete. Will merge this in order to combine with other guides in progress- it won't go live until the "working with data", "interactivity", and "rendering with layouts" tutorials are completed. (a trio of key concepts in a user-facing style, so they can get help without having to know about LZ internals first)