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.

@jprichardson Thinking about the documentation: fs-extra’s docs are rather large. Perhaps we are approaching the size to consider using documentation.js or similar. For smaller libs, I consider this more trouble than it’s worth, but I think I see some benefits here. Thoughts?

Of course, I doubt we can get this done in time for v1.0.0, but looking into the future, this might be the route to pursue.

Refs: https://github.com/jprichardson/node-fs-extra/issues/148.

Issue Analytics

  • State:closed
  • Created 7 years ago
  • Comments:14 (5 by maintainers)

github_iconTop GitHub Comments

1reaction
jprichardsoncommented, Jan 1, 2017

@jprichardson Are we going to be changing anything with the docs for v2?

The only major change that I think makes sense in the short-term is moving everything after the table of contents. If we change other things, that’s fine as well.

0reactions
RyanZimcommented, Jan 12, 2017
Read more comments on GitHub >

github_iconTop Results From Across the Web

API Docs
Hosted API documentation for every OAS (Swagger) and RAML spec out there. Powered by Stoplight.io. Document, mock, test, and more, with the StopLight...
Read more >
API Documentation Made Easy - Get Started - Swagger
Swagger takes the manual work out of API documentation, with a range of solutions for generating, visualizing, and maintaining API docs. Learn more....
Read more >
What Is API Documentation? [+ How to Write and Read It]
API documentation is essentially an instruction manual that explains how to use an API and its services. This manual might contain tutorials, ...
Read more >
How to Write API Documentation: Best Practices and Examples
Most API docs start with authentication and authorization. It should cover info on how to get an API key and how to authenticate...
Read more >
Introduction | Google Docs
The Google Docs API lets you create and modify documents. Apps can integrate with the Docs API to create polished documents from both...
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