Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[RFC] Remove examples/ folder in lieu of proper README documentation? #650

Closed
Qix- opened this issue Dec 19, 2018 · 0 comments
Closed

[RFC] Remove examples/ folder in lieu of proper README documentation? #650

Qix- opened this issue Dec 19, 2018 · 0 comments
Labels
change-minor This proposes or provides a change that requires a minor release discussion This issue is requesting comments and discussion
Milestone
5.x

Comments

@Qix-
Copy link
Member

Qix- commented Dec 19, 2018 •
edited

Right now, the readme is kind of verbose (see #649) - however, it has (and will continue to have) ample examples for how to use this very simple library.

I think the examples folder is prone to becoming outdated (I honestly didn't even notice it was there) and thus a cause for both confusion and maintenance overhead - and thus, it should be removed.

Thoughts?
@Qix- Qix- added discussion This issue is requesting comments and discussion change-minor This proposes or provides a change that requires a minor release labels Dec 19, 2018
@Qix- Qix- added this to the 5.x milestone Dec 19, 2018
@Qix- Qix- mentioned this issue Dec 19, 2018
Open
11 tasks
@Qix- Qix- pinned this issue Dec 19, 2018
@Qix- Qix- unpinned this issue Dec 19, 2018
Qix- added a commit that referenced this issue Dec 19, 2018
@Qix-
remove examples folder (closes #650)
8c3f05e
@Qix- Qix- mentioned this issue Dec 19, 2018
Merged
@Qix- Qix- closed this as completed in #658 Dec 19, 2018
Qix- added a commit that referenced this issue Dec 19, 2018
@Qix-
remove examples folder (closes #650)
c0127b1
alshain added a commit to alshain/debug that referenced this issue Nov 24, 2019
@alshain
Remove links to deleted example files
8d1e69a 
The dedicated example files have been removed as per debug-js#650 

This change removes links in the README to those now deleted files.
This was referenced Mar 11, 2021
Closed
Merged
Open
Merged
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
change-minor This proposes or provides a change that requires a minor release discussion This issue is requesting comments and discussion
Milestone
5.x
Development

No branches or pull requests
1 participant
@Qix-