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

Move main classes documentation from Appendix #54

Open
jxu opened this issue Aug 26, 2019 · 4 comments
Open

Move main classes documentation from Appendix #54

jxu opened this issue Aug 26, 2019 · 4 comments

Comments

@jxu
Copy link
Contributor

jxu commented Aug 26, 2019

The main classes (Beatmap, Library, Client, Replay, Collection) should be high level sections in the docs for easier access (when I first used slider it was not clear that they were even documented in the appendix)

@llllllllll
Copy link
Owner

Would you be interested in opening a PR to add the proposed sections? Maybe we could rename "what is a beatmap" to "beatmap" and then merge that page with "working with Beatmaps" and have some more docs there?

@jxu
Copy link
Contributor Author

jxu commented Aug 26, 2019

I'll try to get around to it.

@llllllllll
Copy link
Owner

Thanks!

@jxu
Copy link
Contributor Author

jxu commented Aug 26, 2019

It makes more sense to me to have the main section be "Beatmap" and "Working with Beatmaps" and class docs to be subsections. I haven't decided yet.

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

No branches or pull requests

2 participants