question-mark
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.

Feature: Updated and more comprehensive documentation

See original GitHub issue

I recently had an issue where I needed Chrono to parse English, but in a DD/MM/YYYY format, which is not the default.

The solution was to use the littleEndian configuration option, which I only found from experimenting with the code, and is not mentioned anywhere in the documentation. In fact, I don’t see anything documented about the createConfiguration() methods.

This is just one example, but I think in general the documentation could use a look over, and maybe even creating a dedicated documentation site like other libraries, would be extremely helpful!

Some documentation tools that might be worth looking into:

Issue Analytics

  • State:closed
  • Created 3 years ago
  • Reactions:3
  • Comments:7 (3 by maintainers)

github_iconTop GitHub Comments

1reaction
wanasitcommented, Jan 9, 2021

Thank you for your suggestion! I just back from holiday and I will look into those options when I have time. Please feel free to try that and create MR without me too.

1reaction
benaubincommented, Dec 31, 2020

@wanasit Since you just switched over to Typescript, maybe we can make use of Typedoc for configuration options and other features?

Read more comments on GitHub >

github_iconTop Results From Across the Web

Feature updates for Windows 10 and later policy in Intune
Then, Specify the feature update you want devices to be running. Complete the policy configuration, including assigning the policy to devices.
Read more >
Agile Manifesto - Working Software Over Comprehensive ...
This is executable documentation that remains accountable to the realities of the working system. Automated tests greatly improve the quality of ...
Read more >
Agile Development Methodology and Documentation - Nuclino
Agile Development Methodology and Documentation · Individuals and interactions over processes and tools · Working software over comprehensive documentation.
Read more >
Applying Agile Management Value 2: Working Software Over ...
The second Agile core value emphasizes working software over comprehensive documentation. On projects using agile management tools, the only way ...
Read more >
Technical Documentation in Software Development - AltexSoft
Documentation exists to explain product functionality, ... Make all this information more comprehensive by using the following practices:.
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found