SciRuby / rubex

rubex - A Ruby-like language for writing Ruby C extensions.
BSD 2-Clause "Simplified" License
451 stars 21 forks source link

Created New UI for rubex docs. #12

Closed Suhas010 closed 1 year ago

Suhas010 commented 7 years ago

Need some more time to create complete UI.

v0dro commented 7 years ago

Hey,

I just had a look at the UI, and overall it looks really good and very well polished. Here's a bunch of things that would be great if changed:

  1. The first 'I love Ruby' part says 'I love C' as well. We use Rubex because we don't like C. Its too tedious to write. So we create an abstraction called Rubex. The color scheme is nice. Pink fits right in. So maybe you can have these three lines:

    • The elegance of Ruby
    • The power of C
    • Say hello to Rubex
  2. On the right hand side there's the paragraph on Rubex. How about removing the quotes and splitting it up like so:

    
    Rubex is a language that makes writing CRuby C extensions as 
    simple as writing Ruby. It does this by providing a syntax that is 
    the perfect blend of the elegance of Ruby and the power of C. 

Rubex compiles to C and implicitly interfaces with the Ruby VM in a manner that is completely transparent to the programmer.

Rubex keeps you happy even when writing C extensions.



3. The paragraph appears too small for my screen (see screenshot). Maybe make it larger and increase the font size? Should be more in-your-face kind of.
![screenshot from 2017-08-21 22-29-11](https://user-images.githubusercontent.com/2629909/29530404-40815346-86c1-11e7-8402-8f28c7f2c6a3.png)

4. The 'Download Rubex' button should point to rubygems - https://rubygems.org/gems/rubex

5. There should be another link called 'GitHub' on the navigation bar that points to the GitHub repo.

6. The code samples on the home page are comparing Ruby with a C extension. They should compare a C extension (i.e. C code) on the left with Rubex on the right. So here's some further improvements to those:
  - The size of the font should be larger. 
  - The padding that the code samples have should be lesser (ideally span the entire column).
  - The heading for the left side (C code) should be - `This C extension calculates Fibonacci numbers'.
  - The heading for the right side (Rubex code) should be - `This C extension _also_ calculates Fibonacci numbers'.
  - And now we basically want to drive home the point that Rubex is a much better way of doing the same thing (i.e writing C extensions) so at the bottom of these columns you can write 'Rubex is better, right?` (bold, large font, again in-your-face kinds).
v0dro commented 7 years ago

Also, the code in code samples on the front page should have 2 space indentation :P

Suhas010 commented 7 years ago

Will make that changes and raise new PR

v0dro commented 7 years ago

You can just push to this PR.

v0dro commented 7 years ago

Any update on this?