starred/spotify-web-api-php

Fork 0

mirror of https://github.com/jwilsson/spotify-web-api-php.git synced 2026-04-26 23:45:49 +03:00

[GH-ISSUE #223] Docs suggestion #159

New issue

Closed

opened 2026-02-27 19:26:22 +03:00 by kerem · 4 comments

kerem commented

2026-02-27 19:26:22 +03:00

Owner

Originally created by @ghost on GitHub (Feb 9, 2021).
Original GitHub issue: https://github.com/jwilsson/spotify-web-api-php/issues/223

Hi Jonathan,

I hope you're well.

This is a bit presumptuous, to suggest an improvement to your docs.

There is a lot of very useful information on the methods reference docs.

I have forked your repository and wondered if you thought adding a table of contents at the top of the page would be useful, like this?

It might not be very sensible to have chopped it up like I have done - another option would be to have a simple list linking to every method since that keeps to the same alphabetical layout as the actual content.

It might be how my brain works but when scanning through the list of methods I find it useful to group them by the initial few characters of the method name (e.g. add, delete, follow, get etc), hence the nested lists layout.

I don't really know how GitHub works in terms of forks etc - but did the fork so I could edit the page on fork to show you what I mean.

Anyway, as I say, I don't want to be seen as saying I know better, it is just a suggestion.

Thanks

Jim

Originally created by @ghost on GitHub (Feb 9, 2021). Original GitHub issue: https://github.com/jwilsson/spotify-web-api-php/issues/223 Hi Jonathan, I hope you're well. This is a bit presumptuous, to suggest an improvement to your docs. There is a lot of very useful information on the [methods reference docs](https://github.com/u20200522/spotify-web-api-php/blob/master/docs/method-reference/SpotifyWebAPI.md). I have forked your repository and wondered if you thought adding a table of contents at the top of the page would be useful, [like this](https://github.com/u20200522/spotify-web-api-php/blob/master/docs/method-reference/SpotifyWebAPI.md)? It might not be very sensible to have chopped it up like I have done - another option would be to have a simple list linking to every method since that keeps to the same alphabetical layout as the actual content. It might be how my brain works but when scanning through the list of methods I find it useful to group them by the initial few characters of the method name (e.g. add, delete, follow, get etc), hence the nested lists layout. I don't really know how GitHub works in terms of forks etc - but did the fork so I could edit the page on fork to show you what I mean. Anyway, as I say, I don't want to be seen as saying I know better, it is just a suggestion. Thanks Jim

kerem

2026-02-27 19:26:22 +03:00

closed this issue
added the
docs
label

kerem commented

2026-02-27 19:26:22 +03:00

Author

Owner

@jwilsson commented on GitHub (Feb 9, 2021):

Hey Jim!
Absolutely no worries! Always happy to get suggestions on how to improve the docs.

I agree that an alphabetical table of contents would be useful. The method reference is automatically generated by a script. Adding a table of contents there shouldn't be a big change, adding it to the template should be enough. If you want to take a shot at adding it, GitHub has some great articles on forking and sending pull requests.

If you have any other questions about the script, don't hesitate to open an issue over there!

Cheers,
Jonathan

@jwilsson commented on GitHub (Feb 9, 2021): Hey Jim! Absolutely no worries! Always happy to get suggestions on how to improve the docs. I agree that an alphabetical table of contents would be useful. The method reference is automatically generated by [a script](https://github.com/jwilsson/phpdoc-md). Adding a table of contents there shouldn't be a big change, adding it to the template should be enough. If you want to take a shot at adding it, GitHub has some great articles on [forking](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo) and [sending pull requests](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request). If you have any other questions about the script, don't hesitate to open an issue over there! Cheers, Jonathan

kerem commented

2026-02-27 19:26:22 +03:00

Author

Owner

@ghost commented on GitHub (Feb 9, 2021):

Hi Jonathan,

That's interesting about the script - thanks for the info.

However, I'll now quietly exit and stop pretending I know stuff 😂😆🤣.

Thanks

Jim

@ghost commented on GitHub (Feb 9, 2021): Hi Jonathan, That's interesting about the script - thanks for the info. However, I'll now quietly exit and stop pretending I know stuff 😂😆🤣. Thanks Jim

kerem commented

2026-02-27 19:26:22 +03:00

Author

Owner

@jwilsson commented on GitHub (Feb 12, 2021):

Hi again Jim!
Just wanted to let you know I've updated the script and method reference with a table of contents.

Cheers,
Jonathan

@jwilsson commented on GitHub (Feb 12, 2021): Hi again Jim! Just wanted to let you know I've updated the script and method reference with a table of contents. Cheers, Jonathan

kerem commented

2026-02-27 19:26:22 +03:00

Author

Owner

@ghost commented on GitHub (Feb 12, 2021):

Hi Jonathan! That's great - thanks very much for that :-)
Wishing you a good weekend.
Thanks
Jim

@ghost commented on GitHub (Feb 12, 2021): Hi Jonathan! That's great - thanks very much for that :-) Wishing you a good weekend. Thanks Jim