Skip to content
This repository has been archived by the owner on Dec 14, 2020. It is now read-only.

Improve readme and create docs #307

Open
7 tasks
btzr-io opened this issue Feb 2, 2019 · 9 comments
Open
7 tasks

Improve readme and create docs #307

btzr-io opened this issue Feb 2, 2019 · 9 comments

Comments

@btzr-io
Copy link
Owner

btzr-io commented Feb 2, 2019

Add guides and documentation:

@btzr-io btzr-io added the docs label Feb 16, 2019
@btzr-io btzr-io changed the title Create docs Improve readme and create docs Mar 3, 2019
@btzr-io btzr-io pinned this issue Mar 3, 2019
@binarygalwalkin
Copy link
Contributor

I will check in on this later :) I have some ideas 👍

@btzr-io
Copy link
Owner Author

btzr-io commented Mar 9, 2019

@binarygalwalkin Let me know if you have any questions ✌️

@btzr-io
Copy link
Owner Author

btzr-io commented Mar 12, 2019

We should probably extend and update description to something like this:

An open-source music and podcasts streaming platform backed by a decentralized network (LBRY)

  • Due to the current centralized apis used is not fully decentralized.

@binarygalwalkin
Copy link
Contributor

@btzr-io I haven't forgotten about these issues. I am working on a deadline outside of GH, right now.

Questions:

  1. How do you want users to access this information? Via app? online? this repo?
  2. Is overall search-ability important to you? You may want to enable the GH Wiki option, or Pages.

Publishing the first documentation page only takes a few minutes.

  • Create a /docs/index.md file on your repository’s master branch.
  • Add your content and any necessary Jekyll front matter, then commit your changes.
  • Visit your repository’s settings tab and select master branch /docs folder as the GitHub Pages source. Click save, and you’re done.

GitHub Pages will read the contents of your /docs directory, convert the index.md into HTML, and publish the results at your GitHub Pages URL.

This will generate the most basic HTML output that you can further customize with templates, CSS, and other features available in Jekyll.

This will give you control, because people will have to create pull requests to submit the content.

I can design some pages for you, but I think you , as the owner, need to do the initial steps above to allow a folder to be created for the content created.

@btzr-io
Copy link
Owner Author

btzr-io commented Mar 16, 2019

I'm all in for the github pages, great idea 👍

@btzr-io
Copy link
Owner Author

btzr-io commented Mar 16, 2019

@binarygalwalkin I'm not sure if I want have the docs files inside this repository, maybe GH Wiki is a better option for this case, What do you think ?

@btzr-io
Copy link
Owner Author

btzr-io commented Mar 17, 2019

Well either way, here are the two options:
https://btzr-io.github.io/jelly-beats/
https://github.com/btzr-io/jelly-beats/wiki

@binarygalwalkin
Copy link
Contributor

@btzr-io Thanks for the swift reply! I will get on this soon :)

@btzr-io
Copy link
Owner Author

btzr-io commented Mar 19, 2019

@binarygalwalkin Hey, feel free to join the discord server: https://discord.gg/EUuHjd

@btzr-io btzr-io added hacktober hacktoberfest Hacktober fest 2018 labels Oct 13, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

2 participants