captbaritone / captbaritone/webamp

[Documentation] Could a FAQ be added?

Open
#1,240 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
TypeScript
Stars
11.3k
Forks
796
PR merge metrics
No merged PRs in 30d

Description

Hey folks,

I just semi-accidentally discovered webamp, when I was looking for a java clone
of the old winamp, actually.

The current README shows how to embed it, which is fine. But, after that step,
I'd have a few questions. For instance, how to easily add a bunch of songs?
Like .add_songs() or something. I am sure this is easy to find out, but could
you guys perhaps consider adding a FAQ, where such easy questions are
quickly answered? I could then go through that FAQ and collect useful
information into it.

So as one entry I would like to suggest:

"How to add one or more songs to the webamp interface?"

And of course to extend this. The FAQ could be maintained in the
wiki of github here, and/or in a separate .md file or something such
as FAQ.md. It may probably be too long to add to the main README
directly, but when it is added perhaps the main README can add
a link to it.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with the current README's embedding instructions and review how users add songs to the webamp interface. Decide whether the FAQ belongs in the GitHub wiki or a separate FAQ.md file, add the suggested question and answer, extend it with useful follow-up questions, and link it from the README.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.