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.

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

Documentation #20

Closed
javacafe01 opened this issue Feb 13, 2021 · 8 comments
Closed

Documentation #20

javacafe01 opened this issue Feb 13, 2021 · 8 comments
Labels
documentation Improvements or additions to documentation

Comments

@javacafe01
Copy link
Member

As bling grows, we need to get rid of the readme and make actual documentation. Any ideas on what to use or generate? If we choose on one, I can get started.

@javacafe01 javacafe01 added the documentation Improvements or additions to documentation label Feb 13, 2021
@heavyrain266
Copy link
Contributor

I think wiki section with pages for each module is enough. Alternativelyy we can create website hosted on github with documentation website generator like this https://docsify.js.org/#/

@javacafe01
Copy link
Member Author

we can create website hosted on github with documentation website generator like this https://docsify.js.org/#/

I like this generator, so far with our current readme it looks like this:

image

javacafe01 added a commit that referenced this issue Feb 13, 2021
@heavyrain266
Copy link
Contributor

heavyrain266 commented Feb 14, 2021

Actually this is very nice, now we wait fro @Nooo37 comment on this, also mayby we should remove emojis looks a bit weird on website?

@Nooo37
Copy link
Member

Nooo37 commented Feb 14, 2021

Docsify is very good looking and probably more appealing than a github wiki. We should just make sure to add support for lua syntax highlighting because especially longer code blocks like the ones on the declarative wallpaper module become unreadable without it.

@javacafe01
Copy link
Member Author

We should just make sure to add support for lua syntax highlighting because especially longer code blocks like the ones on the declarative wallpaper module become unreadable without it.

Yup, it uses prism for syntax highlighting.
image

@javacafe01
Copy link
Member Author

@branwright1 @Nooo37 i finished the docs up in the docs branch, take a look if there are any edits needed or if there is anything i forgot

also @Nooo37 if this is all good i think u should host it on github

@javacafe01 javacafe01 mentioned this issue Feb 16, 2021
Merged
@heavyrain266
Copy link
Contributor

For now I found only 2 problems:

  • Images/gifs at the top can take a while to be loaded or sometimes need to reload website in order to see them
  • I think this text should be above gif or under it because looks a bit weird compared to other pages.
    img

Small suggestion:

  • Reduce a bit size of preview images/gifs on every pages, they are too big imo.
  • img

@javacafe01
Copy link
Member Author

done with #21 , will reduce size @branwright1

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants