-
-
Notifications
You must be signed in to change notification settings - Fork 32
Improve readme and create docs #307
Comments
I will check in on this later :) I have some ideas 👍 |
@binarygalwalkin Let me know if you have any questions ✌️ |
We should probably extend and update description to something like this:
|
@btzr-io I haven't forgotten about these issues. I am working on a deadline outside of GH, right now. Questions:
Publishing the first documentation page only takes a few minutes.
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. |
I'm all in for the github pages, great idea 👍 |
@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 ? |
Well either way, here are the two options: |
@btzr-io Thanks for the swift reply! I will get on this soon :) |
@binarygalwalkin Hey, feel free to join the discord server: https://discord.gg/EUuHjd |
Add guides and documentation:
The text was updated successfully, but these errors were encountered: