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.

Better docs with live examples

See original GitHub issue

Hello everyone.

Last year react-native-redash helped me a lot, saving countless hours of work. Unfortunately, the documentation is not always easy to understand (IMO, a large README.md file is not the best way to handle it).

I’ve been thinking about a way to improve it, and since last Saturday I’ve been working on a new documentation/site:

It’s basically using gatsby and react-native-web for live examples (we only have a single live example for now: https://react-native-redash-docs.netlify.com/animations/bInterpolate/).

@wcandillon if you like/agree, I can transfer the ownership to you immediately, so we can keep improving it as needed (I think we should add more live examples, as it’s easier to understand what’s happening).

Thanks!

Issue Analytics

  • State:open
  • Created 4 years ago
  • Reactions:24
  • Comments:7 (4 by maintainers)

github_iconTop GitHub Comments

3reactions
felippepuhlecommented, Jan 26, 2020

@wcandillon can I close this?

0reactions
whalemarecommented, Oct 20, 2020

No, we need samples

Read more comments on GitHub >

github_iconTop Results From Across the Web

BetterDocs - Best Documentation & Knowledge Base Solution ...
BetterDocs is an advanced documentation & knowledge base plugin for WordPress that will help you improve your user experience and reduce support tickets....
Read more >
SoftwareBrothers/better-docs: Beautiful toolbox for jsdoc ...
Beautiful toolbox for jsdoc generated documentation - with 'typescript', `category` and `component` plugins - GitHub - SoftwareBrothers/better-docs: ...
Read more >
BetterDocs – Best Documentation & Knowledge Base Plugin
STUNNING READY TEMPLATES FOR DOCS LANDING PAGE ... BetterDocs offer multiple ready templates to design your WordPress documentation site within a few minutes....
Read more >
TypeScript + JSDoc = better-docs - Wojciech Krysiak - Medium
better -docs was created as a simple (yet beautiful) theme for JSDoc generated documentation. Over the last months, at SoftwareBrothers, we've added it...
Read more >
How to Set Up a WordPress Knowledge Base with BetterDocs
BetterDocs is a comprehensive knowledge base plugin that is completely free and simple to use. It allows users to build large knowledge bases...
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