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 updates, improvements. #335

Closed
wants to merge 4 commits into from

Conversation

shybovycha
Copy link

  • Removed the railway-routes injection. But the bugs at the current version of railway-routes are truly critical. Pull request at the correspondent repository is sent.
  • Updated documentation at doc/sources/markdown
  • Left the templates/app/assets/nib/ and nib injection untouched -- i was not able to import nib anyhow. If you can use nib without just copying its files to the app/assets/stylesheets directory - provide a valid step-by-step manual, please. Until that, it is an improvement. I really insist you to merge this change.

…ds were passed via URI. Bundled railway-routes and fixed the pathTo helper -- now matching and replacing the route params. Added some documentation coverage. Bundled nib to those projects containing stylus as CSS engine.
@1602
Copy link
Owner

1602 commented Jan 17, 2013

Well, probably nib is awesome, but copying it's sources to the core is totally wrong. If you need these files in your project - just copy it to the project. If you need some command to automate it - no problem, you can create 3rd-party generator and add it as extension. Feel free to mention it in documentation. Correct workflow looks like:

  1. build separate package 'compound-nib' which will add nib generator.
  2. integration point is 'config/autoload.js'
  3. use command 'compound generate nib' to add nib features to your application

as an improvement of workflow i would suggest to build some user-wide autoload located in ~/.compound/autoload.js for example, which will load some extensions automatically, without cluttering core code.

Reasons of all this pain:

  1. we don't have to mirror updates of nib inside core
  2. users who don't want to use nib wouldn't suffer of unnecessary files in generated project
  3. git log -p will be useful, because it will only track compound code

Thanks for your patience, and I hope you understand why I'm fighting against copying foreign code.

…es. Added form helper to insert a radio button.
…on of connect which depends on my version of qs which fixes the major bug.
@1602 1602 closed this Jan 19, 2013
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.

None yet

2 participants