Bring minimal viable website to life #394

cburgdorf · 2021-05-07T10:19:53Z

What was wrong?

We've received an amazing website draft from @PascalPrecht that we now need to integrate with docs, fill with actual content and just iterate on to reach a minimal viable version that can go live.

Well...strictly speaking it is already live at http://fe.ethereum.org as I'm just treating that as my staging ground for now (we don't promote that URL anywhere yet).

How was it fixed?

Created a website directory in the root that hosts the html and logos
- The logos are actually duplicated from the "logos" directory but as far as git bloat is concerned that isn't a problem since git deduplicates everything on a level of binary blobs
Turned the existing docs sites and spec into an mdBook
Migrated the deployWebsite.sh into a few new make tasks
- make build-website -> Build the website, docs, api-docs into target/website
- make serve-website -> Build and serve on localhost:8000
- make deploy-website -> Deploy to live site
- It's rudimentary but gets the job done for now
Code of Conduct
Created a Quickstart stub
Came up with actual texts for the various design elements and linked to places that make sense

codecov-commenter · 2021-05-07T10:46:47Z

Codecov Report

Merging #394 (96f0431) into master (ae5c2a8) will not change coverage.
The diff coverage is n/a.

❗ Current head 96f0431 differs from pull request most recent head 5f505ef. Consider uploading reports for the commit 5f505ef to get more accurate results

@@           Coverage Diff           @@
##           master     #394   +/-   ##
=======================================
  Coverage   86.06%   86.06%           
=======================================
  Files          67       67           
  Lines        4004     4004           
=======================================
  Hits         3446     3446           
  Misses        558      558

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update ae5c2a8...5f505ef. Read the comment docs.

cburgdorf · 2021-05-10T15:42:16Z

@g-r-a-n-t @sbillig This is ready for review. It's not entirely finished yet. E.g. the Quickstart doesn't have any actual content yet but I created a stub site for it. I plan to spend some more time on that. I actually want to write a proper tutorial that even deploys some code to the Görli network. But I think there's enough in this PR to get it in and then keep iterating. Everything can be viewed live on https://fe.ethereum.org already

g-r-a-n-t · 2021-05-10T17:23:10Z

website/index.html

+  23
+
+                      </div>
+                      <code class="flex-auto relative block text-white pt-4 pb-4 px-4 overflow-auto">contract Ownable:


I think we should use the guest book demo here, since ownable is used as an inherited contract.

Ah good point. Eventually it would be nice to demo something that uses the new string<100> syntax when it is ready. I'll use the guest book for now.

I've put in some comments and syntax highlighting (Python for now) because the example is shorter and I needed it to consume a bit more space to fit in nicely

g-r-a-n-t · 2021-05-10T17:32:32Z

website/index.html

+      <img class="h-52 lg:h-72 lg:ml-8 xl:ml-0 hidden sm:block" src="fe-logo.svg" alt="Fe Programming language">
+      <div class="sm:mt-14 md:ml-16 md:mt-0 max-w-3xl lg:max-w-2xl xl:max-w-3xl xl:-ml-4">
+        <h2 class="text-5xl sm:text-6xl xl:text-6xl leading-none font-semibold tracking-tight">The <span class="text-gray-100">next generation</span><br> smart contract language for Ethereum</h2>
+        <p class="text-lg sm:text-2xl text-gray-700 leading-6 sm:leading-8 mt-4">Create <span class="text-gray-900 font-semibold">decentralized applications</span> in a powerful, future-proof and <span class="text-gray-900 font-semibold">statically typed</span> language that is very <span class="text-gray-900 font-semibold">easy to learn</span>.<p>


IMO the text-gray-700 and text-gray-900 colors are a bit too close. Also, I think we want 900 to pop a bit more, so maybe that one should be the lighter shade.

I increased the contrast between them but switching them didn't look good to me. Probably because then we would not have the contrast to the headline above. But if truly suck at design work so if there is potential for optimizations I would ask Pascal post-merge to give it a make over.

looks good 👍

sbillig · 2021-05-10T21:42:57Z

Looks great! I think we should add a note that fe is alpha software and not ready for production use, near the download button. Or a flashing 'under construction' gif.

g-r-a-n-t · 2021-05-11T02:42:52Z

Very exciting. I just have a few suggestions for the page head.

Create decentralized applications in a powerful, future-proof and statically typed language that is very easy to learn.

I think it would read better if we got rid of "very". It makes things more concise, which I think is important here.

The syntax of Fe is inspired by Python and Rust. It is easy to learn, even for those who have never dealt with EVM before. Fe was developed with audits in mind making it very easy to write safe code.

Suggestion: The syntax of Fe is inspired by Python and Rust. It is easy to learn, even for those who have never dealt with the EVM before. Fe is designed to be safe and equipped with the tooling needed to validate contracts.

Fe restricts dynamic program behavior making the language more reliable in return. Features such as generic types over constant values improve decidability without compromising expressiveness.

Suggestion: Fe seeks to restrict dynamic behavior without limiting expressiveness. Features like constant generics let you write clean code without sacrificing compile-time guarantees.

cburgdorf · 2021-05-11T09:20:18Z

add a note that fe is alpha software and not ready for production use, near the download button

I added a note. Might need a follow up design tweaking.

Also, the Download button currently links to the release page from where the user will have to navigation through more information to find the actual binary. We might want to read out the current Fe version and then directly link to the binary. But that will need to go with an OS detection to link to the correct binary (or show multiple buttons "Download for Mac", "Download for Linux" etc.). But that's something we can tackle later.

cburgdorf · 2021-05-11T09:44:50Z

@g-r-a-n-t Thanks for the suggestions. I took them all 👍

So, are we good to merge this? I'll keep working on Quickstart, Tutorial and other guides for a bit but I can ping Pascal post-merge to check my changes and maybe tweak them design wise.

g-r-a-n-t · 2021-05-11T14:14:44Z

LGTM

cburgdorf changed the title ~~Bring minimal viable website to live~~ Bring minimal viable website to life May 7, 2021

cburgdorf force-pushed the christoph/feat/website branch from 9aa132e to 9177a6f Compare May 10, 2021 15:27

cburgdorf added 7 commits May 10, 2021 17:38

Add website draft & hook up deployment

e7e883b

Add link to compiler API docs

07a4f96

Use mdBook to build doc files

ccd8e91

Include docs in website script & allow --serve to preview locally

8569aa4

Move spec into Fe guide

d0a95f8

Add quickstart stub

ff72337

Add code of conduct

5f7a89c

cburgdorf force-pushed the christoph/feat/website branch from 9177a6f to e88874f Compare May 10, 2021 15:38

cburgdorf marked this pull request as ready for review May 10, 2021 15:39

cburgdorf requested a review from g-r-a-n-t May 10, 2021 15:39

Fill website content with life and love

fe6e66b

cburgdorf force-pushed the christoph/feat/website branch from e88874f to 0267c17 Compare May 10, 2021 15:43

g-r-a-n-t reviewed May 10, 2021

View reviewed changes

cburgdorf force-pushed the christoph/feat/website branch from c11bf41 to 96f0431 Compare May 11, 2021 09:28

cburgdorf added 5 commits May 11, 2021 11:51

Move website tasks into Makefile

70f0133

Use guestbook and use syntax highlighting

83f16f6

Increate contrast in subline

e784c9c

Tweak Download button and add alpha warning

fd7cf85

Tweak wording

5f505ef

cburgdorf force-pushed the christoph/feat/website branch from 96f0431 to 5f505ef Compare May 11, 2021 09:51

g-r-a-n-t self-requested a review May 11, 2021 14:15

g-r-a-n-t approved these changes May 11, 2021

View reviewed changes

cburgdorf merged commit 442e0b7 into ethereum:master May 11, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Bring minimal viable website to life #394

Bring minimal viable website to life #394

cburgdorf commented May 7, 2021 •

edited

Loading

codecov-commenter commented May 7, 2021 •

edited

Loading

cburgdorf commented May 10, 2021 •

edited

Loading

g-r-a-n-t May 10, 2021 •

edited

Loading

cburgdorf May 10, 2021

cburgdorf May 10, 2021

g-r-a-n-t May 10, 2021 •

edited

Loading

cburgdorf May 10, 2021

g-r-a-n-t May 11, 2021

sbillig commented May 10, 2021

g-r-a-n-t commented May 11, 2021 •

edited

Loading

cburgdorf commented May 11, 2021

cburgdorf commented May 11, 2021

g-r-a-n-t commented May 11, 2021

Bring minimal viable website to life #394

Bring minimal viable website to life #394

Conversation

cburgdorf commented May 7, 2021 • edited Loading

What was wrong?

How was it fixed?

codecov-commenter commented May 7, 2021 • edited Loading

Codecov Report

cburgdorf commented May 10, 2021 • edited Loading

g-r-a-n-t May 10, 2021 • edited Loading

Choose a reason for hiding this comment

cburgdorf May 10, 2021

Choose a reason for hiding this comment

cburgdorf May 10, 2021

Choose a reason for hiding this comment

g-r-a-n-t May 10, 2021 • edited Loading

Choose a reason for hiding this comment

cburgdorf May 10, 2021

Choose a reason for hiding this comment

g-r-a-n-t May 11, 2021

Choose a reason for hiding this comment

sbillig commented May 10, 2021

g-r-a-n-t commented May 11, 2021 • edited Loading

cburgdorf commented May 11, 2021

cburgdorf commented May 11, 2021

g-r-a-n-t commented May 11, 2021

cburgdorf commented May 7, 2021 •

edited

Loading

codecov-commenter commented May 7, 2021 •

edited

Loading

cburgdorf commented May 10, 2021 •

edited

Loading

g-r-a-n-t May 10, 2021 •

edited

Loading

g-r-a-n-t May 10, 2021 •

edited

Loading

g-r-a-n-t commented May 11, 2021 •

edited

Loading