Skip to content
This repository has been archived by the owner on May 10, 2022. It is now read-only.

[Suggestion] Api Docs / Github Pages #32

Open
PDDStudio opened this issue Sep 17, 2020 · 3 comments
Open

[Suggestion] Api Docs / Github Pages #32

PDDStudio opened this issue Sep 17, 2020 · 3 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request question Further information is requested

Comments

@PDDStudio
Copy link
Member

Hi,

first of all, great work with that package as you already know 👍

I just realized that we don't have any Api Docs or any nice GitHub Page which contains an overview of the project.
So maybe it might be a nice addition to the repository.

Feel free to hit me up at work so we can talk about it in more details if you want to 🙂

Regards,
Patrick

@PDDStudio PDDStudio added documentation Improvements or additions to documentation enhancement New feature or request question Further information is requested labels Sep 17, 2020
@c15yi
Copy link
Member

c15yi commented Sep 18, 2020

Hey,

I think we actually have an API doc and an overview. 😄

I am not saying they are perfect though 🙂

Improvements are of course always welcome. Sure we can talk about that later.

Best,
Christian

@PDDStudio
Copy link
Member Author

PDDStudio commented Sep 19, 2020

@ChristianNavolskyi This is how it could look like using just the README content and one of the default themes:
Hosted on my fork
We could also go for something more custom that looks nicer, what do you think?

Edit: Seems like sometimes the GIFs are missing, which makes it less attractive IMO 🤔
I would consider switching to something more custom/solid then

@c15yi
Copy link
Member

c15yi commented Sep 19, 2020

Hey @PDDStudio,

I think that looks actually very nice.
The missing GIF are of course a bummer, do you think that is easily fixable? Maybe just the link is broken or something.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Improvements or additions to documentation enhancement New feature or request question Further information is requested
Projects
None yet
Development

No branches or pull requests

2 participants