JuliaGizmos/Escher.jl

Documentation

Open

#26 opened on Jun 5, 2015

View on GitHub
 (3 comments) (0 reactions) (0 assignees)Julia (334 stars) (64 forks)batch import
documentationhelp wanted

Description

While I want to write all of this out myself, my hands don't seem to like the idea so much. Here is a table of contents of the things I want to document. Any help with documentation will be hugely appreciated!

Take a look at docs/index.jl, docs/layout.jl, docs/reactive.jl, docs/layout-api.jl to see how documentation can be written.

API Documentation

  • @api & @apidoc macros
  • Tile & TileList
  • Length
  • Utility functions
  • Layout
  • Content
  • Typography
  • Embellishment
  • Signals & Behaviors
  • Window
  • Higher-order Layouts

User Guide

WIP PR: #67

  • Overview
    • How to install
    • Rules that make Escher
    • Under the hood (Optional)
    • How to read the manual
  • Content
    • Text & Markdown
    • Code
    • LaTeX
    • Vector Graphics (with Compose)
    • Plots (with Gadfly)
    • Tables from dataframes
    • Images
    • Icons
    • Links
    • Abbreviations
    • Table of Contents (TODO)
    • Converting data to Tile
  • Layout
    • Sizing and padding
    • vbox, hbox
    • grow & shrink
    • Packing space
    • Absolute positioning
    • Floating and Image placement (TODO)
  • Borders and Colors
    • How to use Color.jl
    • fillcolor
    • borders
    • rounded corners
  • Typography
    • Higher-level typography functions
    • Lower-level functions
  • Input Widgets
    • How to get input
    • Tiles of the Behavior type
    • Slider
    • Text box
    • Checkbox & Toggle button
    • Dropdown menu
    • Selection (TODO)
    • Radio buttons
    • CodeMirror
  • Pages & higher-order layout
    • Pages
    • Tabs
    • Slideshows
    • Toolbars
    • Menu
    • Items
  • Reactive programming & Interactive UIs
    • Signals
    • Creating signals
    • Interpreters
    • Maintaining state
    • Minesweeper explained

Contributor guide

Tech stack
None
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
basic Julia knowledgefamiliarity with Markdown
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
Review the existing documentation files such as docs/index.jl, docs/layout.jl, docs/reactive.jl, and docs/layout api.jl to understand the formatting style. Choose any unchecked item from the list (e.g., @api macro or Window API) and write documentation following the patterns in the existing files. Consider updating the corresponding .jl file and submitting a pull request.