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

Renew of the documentation #24

Closed
wants to merge 1 commit into from
Closed

Renew of the documentation #24

wants to merge 1 commit into from

Conversation

Kovah
Copy link
Contributor

@Kovah Kovah commented Nov 16, 2016

I had some difficulties with getting started and had to search re-read large parts of the documentation to understand how some things are working.
That's why I sat down and thought about how to improve the documentation and here are the changes:

  • Restructures the docs into more categories, splits 'making games' into multiple documents
  • Use Grunt to compile all assets and moves them into new directory
  • Styles are now handled by Sass
  • Update to Bootstrap 4
  • Replace Prettify.js with highlight.js
  • Updates the base templates

Previews

Precompiled assets
At the moment some of the assets like styles.css and JS dependencies are removed from version control. If it's necessary to have them available in the repo, we can commit them again.


I really hope that all changes are fine. If not, just leave a comment and I will correct. 😃

* Use Grunt to compile all assets and moves them into new directory
* Update to Bootstrap 4
* Replace Prettify.js with highlight.js
* Restructures the docs into more categories, splits 'making games' into multiple documents
* Updates the base templates
@greggman
Copy link
Owner

It's amazing that you're putting so much work into this. Is there any way you and break this into multiple PRs? There's too much to look at here.

Examples:

  • a pr to move the assets
  • a pr to use scss
  • a pr to update .md files
  • a pr to replace prettify.js with highlight.js

etc...

Also a few things

  1. I don't build the docs. In other words if you're updating .md files please only update those. Don't update the corresponding html files.
  2. Please stick to the style as is. Do not remove blank lines, don't add or remove spaces, don't go changing coding styles please. Thanks.

@Kovah
Copy link
Contributor Author

Kovah commented Nov 16, 2016

Yeah I really like this project, it's astonishing how well the system works and I know how important help is.
I will try to split this up into multiple PRs tomorrow.

If HTML files should not be updates would it make sense to completely remove them from the repository?
Also, do you have an example where the code style was changed? Can't remember all changes..

@greggman
Copy link
Owner

greggman commented Nov 16, 2016

It's hard to read the diffs and I didn't go searching for all places but for example in changelist.md the diff appears to show all blank lines removed and a few other files. In writing-games.md moved from makinggames.md the controller.js section has been refomatted similarly in other places. In Gruntfile.js spaces have been added after function. Names have been changed to have under_scores. In some HTML files tags have been changed from <tag /> to <tag/> etc..

@Kovah
Copy link
Contributor Author

Kovah commented Nov 16, 2016

Ok I will look into this.

@Kovah
Copy link
Contributor Author

Kovah commented Nov 17, 2016

What about the HTML files? Should they be removed from the repo if they should not be commited anyway?

@Kovah Kovah closed this Nov 17, 2016
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

Successfully merging this pull request may close these issues.

2 participants