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.

[DISCUSS] README content and folder naming

See original GitHub issue

Instead of having all the example explanation in the main README, I would rather see them moved to their dedicated folder.

Regarding the folder name, I would rather remove the prefix number. A the end, we can not order the examples by difficulty, only maybe by area


@jtpio WDYT? After merge of #1 I can quickly open a PR for this.

Issue Analytics

  • State:closed
  • Created 4 years ago
  • Comments:5 (2 by maintainers)

github_iconTop GitHub Comments

echarlescommented, Nov 11, 2019

@jtpio I have merged #1 and opened #3 PR for review. Thx.

jtpiocommented, Nov 10, 2019

Thanks @echarles for the suggestion, that sounds good 👍

We can always reintroduce an order later (a table of contents for instance) if we think it’s needed.

Read more comments on GitHub >

github_iconTop Results From Across the Web

Files and Folders: README files - Research Guides
A glossary of abbreviations used in the name of the folder/file and what they stand for - and definitions if needed.
Read more >
Folder-Structure-Conventions/ at master - GitHub
Folder Structure Conventions. Folder structure options and naming conventions for software projects. A typical top-level directory layout .
Read more >
README Files - Harvard Biomedical Data Management
README Files are a common way to document the contents and structure of a folder and/or a dataset so that a researcher can...
Read more >
Guide to writing "readme" style metadata
Create readme files for logical "clusters" of data. · Name the readme so that it is easily associated with the data file(s) it...
Read more >
README - Wikipedia
In software development, a README file contains information about the other files in a directory ... The file's name is generally written in...
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 Post

No results found

github_iconTop Related Hashnode Post

No results found