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 should be more readable #2

Open
arcadiogarcia opened this issue Aug 27, 2017 · 3 comments
Open

Documentation should be more readable #2

arcadiogarcia opened this issue Aug 27, 2017 · 3 comments
Assignees

Comments

@arcadiogarcia
Copy link
Member

No description provided.

@ShinyStar
Copy link
Member

Some things that could make the documentation more readable:

  • Where there are many functions or properties or similar, make them easier to go through (and pretty :3) by making the names bold or adding a line break after the name and leaving a space before the next one. This can be applied to "Manifest", "Components", "Events", "Collisions", "Object API", "Levels" and "Advanced Component API".

  • Add subheaders in sections for clarity and for easily finding what you are looking for.

  • I would add the header at the top of the text because sometimes I don't know where I am. 😆

  • "Spritesheet.js"'s style is different from the rest.

  • Not sure what the best way would be but it should be made clearer how you can move the camera since you have to know the rendering library API to do it.

  • There are a few silly typos everywhere. Don't forget some full stops which are missing.

@arcadiogarcia
Copy link
Member Author

Documentation section headers added in 3ecb937

Camera movement is covered in "Object API", but since it is hard to find if you don't know where to look we should probably consider a way to increase discoverability (blog posts?)

@arcadiogarcia
Copy link
Member Author

I have made a few more CSS tweaks to increase readability and added examples to most of the items in the "Object API" 30765bc

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

No branches or pull requests

2 participants