Skip to content

thehydroimpulse/rust-website

Repository files navigation

Rust Website

Just a quick Node app to get the bones together.

The goal of this repository is to get together and start improving the current Rust home page, documentation and tutorial sections. Having a solid, clean website can be a huge advantage to language adoption. It makes it easier for people to learn it.

Light Brown

Thus, our goals are many:

  • Make it dead-simple to install Rust. The details on getting Rust's compiler to this point might not happen right away, but making thinking about and designing it in, will help.
  • Provide Rust code straight away. The content is irrelevent, but just a few examples will immediately show what the syntax is like. Many languages, or even libraries require you to dig through many pages to find simple syntax.
  • Enforce that Rust is a community project. IRC within the Rust community is also a huge thing. These should be explained to the end-user in a concise way.

As far as the documentation, here are some ideas:

  • Provide examples and context for each function. There are many times where the single function definition and a brief explanation gives you no clue on how to use it effectively. Thus, giving context would be best.
  • A consistent sidebar (left-hand) that shows the current context with ways on going back.

Have anything to add, discuss, or critique? Open an issue.

Usage

All the styles are written in Sass. To quickly do a one-off build:

make sass

To keep watching files for changes:

make watch

Run the node app:

node index.js

External Dependencies (Client-side)

  • Awesome Font
  • jQuery - Probably don't need it. Just using it for a few selectors.
  • Normalize (CSS)

License

MIT

About

Rust Website

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published