search

crystal-lang / crystal-website

crystal-lang.org website
61 stars 77 forks source link

Integrate docs and API with official website. #51

Open faustinoaq opened 7 years ago

faustinoaq commented 7 years ago

By @spalladino on https://github.com/crystal-lang/crystal-website/issues/19

@flagello if you're interested in exploring other sections, feel free to take a look at what we have designed so far for the book and the API reference. We haven't started implementing them, so suggestions are welcome. Keep in mind though that we fully give our designer the last word on how the site should look like ;-)

Some images:

213804748

213868242

Also Devdocs search is a good inspiration:

devdocs

Wulfklaue commented 6 years ago

The color and style integration for the API is a very welcome change ( the current design sticks out very much ).

But i do always question to use of putting all the API on a single page. For bitarray its less of a issue as its only a two pager but take for instance IO.

http://br.crystal-lang.org/api/IO.html

That is a 20 pager ( more on a 1080p screen ).

Is it not more logical to first have a "overview" page and then have every function and instants ( with a short description ), what then links to its own sub-page ( with the Description, Example(s), View Source)?

As the language and api grows, it will also introduce more clutter in the documentation.

hugoabonizio commented 6 years ago

@Wulfklaue didn't noticed brazilian version was outdated. I can fix that if I find where is it located :smile:

Wulfklaue commented 6 years ago

@hugoabonizio , do not have a clue where its located, i simply pulled the API from a google search to show as a example, did not even realize it was the Brazilian version ( what makes no sense as my geographic location is German ). Google being Google i assume? :)

hugoabonizio commented 6 years ago

@Wulfklaue The whole API docs under this domain are in english anyway :laughing: