Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Write a Developer Guide

See original GitHub issue

Coming from #356, which will complicate matters even more, we need to write a developer guide.

Last Updated: March 18, 2017 Most of the below tasks have been resolved in either the javadoc or in the Wiki

Master TODO List

Write a page that explains, or refers readers to pages that explain, RTFX’s dependencies
Explain how to implement a custom style object
Explain how to implement a custom object in a paragraph’s segment
Explain how to implement a custom SegmentOps
Explain how to implement a custom TextOps
Write a page about how to use Codecs properly
Determine a way to teach frequently-used API to new users

(original comment) It should address the following issues:

RTFX’s CSS (already written via the CSS Ref Guide
How to implement a custom Style object
Gotchas, quirks, and other things to be aware of
frequently-used API to help get a person started

Issue Analytics

State:
Created 7 years ago
Reactions:3
Comments:19 (13 by maintainers)

Top GitHub Comments

1reaction

afestercommented, Oct 10, 2017

Should we add a check for the proper JDK to the gradle build?

1reaction

JordanMartinezcommented, Jan 25, 2017

I’ve included a page about implementing custom style objects in the guide.

Top Results From Across the Web

8 Great Examples of Developer Documentation - Zapier

Look for the documentation features you like and use them in your own docs to make your own documentation more valuable.

About this guide | Google developer documentation style guide

This style guide provides editorial guidelines for writing clear and consistent Google-related developer documentation.

Docs for Developers – Documentation for Everyone

Docs for Developers demystifies the process of creating great developer documentation, following a team of software developers as they work to launch a...

How to Write a Good Documentation: Home

This guide will help you to prepare your code for publishing through writing a good documentation. Documentation.

How to write good software technical documentation - Medium

This article aims to help developers to write better documentation. As a developer, I hate writing documentation. But I hate even more ...