statgen / locuszoom

A Javascript/d3 embeddable plugin for interactively visualizing statistical genetic data from customizable sources.

https://statgen.github.io/locuszoom/

MIT License

154 stars 29 forks source link

Documentation improvements #186

Closed abought closed 3 years ago

abought commented 4 years ago

Purpose

The LocusZoom documentation is incomplete, and manually maintained. This makes it difficult to keep up to date.

Scope of work

Changes to existing documentation

[x] Copy existing documentation from wiki to GitHub repo, as a historical reference for older versions. Blocker for 0.11 release (at least one release must have time-stamped versioned docs before we rewrite internals in 0.12!)
[x] Convert all doc information to JSDoc format comments
[x] Transition doc builds to JSDoc and add them to github pages.
[x] New topic guides, and create a section on the wiki to cover this.
[x] Add/expand key information

New topic guides

Aimed at helping developers to get started with complex topics in LZ, for which documentation and examples may be especially dense or scarce.

[x] Working with data
[x] Layouts and rendering (revise existing tutorial, cover pieces and key options like scalable parameters)
[x] Guide to interactivity
~Future: extending LocusZoom with plugins: creating custom data layers, sources, etc.~
[x] Harmonize JSDoc with wiki
- [ ] Remove content of the wiki as of v0.13.0 release
[x] Make doc structure consistent, add landing pages

abought commented 3 years ago

We've added many mechanisms for interactivity in recent releases, and these are presently under-documented. (semi-public APIs that are being refined based on usage)

Modifying the plot programmatically is a complex topic that requires knowledge of the internals, and it would be a good candidate for a guide.