Bring minimal viable website to life

.github/PULL_REQUEST_TEMPLATE.md

@@ -8,7 +8,7 @@
 ### To-Do
 
 [//]: # (Stay ahead of things, add list items here!)
-- [ ] OPTIONAL: Update [Spec](https://github.com/ethereum/fe/blob/master/spec/index.md) if applicable
+- [ ] OPTIONAL: Update [Spec](https://github.com/ethereum/fe/blob/master/docs/src/spec/index.md) if applicable
 - [ ] Add entry to the [release notes](https://github.com/ethereum/fe/blob/master/newsfragments/README.md) (may forgo for trivial changes)
 
 - [ ] Clean up commit history

Makefile

@@ -1,3 +1,55 @@
+.PHONY: build-website
+build-website:
+	echo -e "\033[0;32mBuilding website...\033[0m"
+
+	# Ensure we start from a clean state
+	rm -rf target/website
+
+	# Copy the entire website directory to target/website
+	cp -r website/ target/
+
+	# Generate the compiler API docs
+	cargo doc --no-deps --workspace
+
+	# Move the API docs into the compiler-docs subdirectory within the website
+	mv target/doc target/website/compiler-docs
+
+	# Generate the Fe guide into the docs subdirectory within the website
+	cd docs; mdbook build -d ../target/website/docs
+
+.PHONY: serve-website
+serve-website: build-website
+		echo -e "\033[0;32mServing website locally...\033[0m"
+		cd target/website; python3 -m http.server 8000
+
+.PHONY: deploy-website
+deploy-website: build-website
+		echo -e "\033[0;32mDeploying website...\033[0m"
+		# delete old gh-pages-tmp + gh-pages-dist branch if they exists
+		-git branch -D gh-pages-tmp gh-pages-dist
+
+		# Recreate it
+		git checkout -b gh-pages-tmp
+
+		# Add changes to git.
+		git add -f target/website
+
+		# Commit changes.
+		git commit -m "Generated website"
+
+		# Only preserve target/website as the root of contents for this branch
+		git subtree split -P target/website -b gh-pages-dist
+
+		# Push to Github Pages
+		git push -f upstream gh-pages-dist:gh-pages
+
+		# Go where we came from
+		git checkout -
+
+		# Delete temporary branches
+		git branch -D gh-pages-tmp
+		git branch -D gh-pages-dist
+
 .PHONY: docker-test
 docker-test:
 	docker run \

README.md

@@ -32,7 +32,7 @@ Additional information about design goals and background can be found in the [of
 
 ## Language Specification
 
-We aim to provide a full language specification that should eventually be used to formally verify the correctness of the compiler. A work in progress draft of the specification can be found [here](https://github.com/ethereum/fe/blob/master/spec/index.md).
+We aim to provide a full language specification that should eventually be used to formally verify the correctness of the compiler. A work in progress draft of the specification can be found [here](http://fe.ethereum.org/docs/spec/index.html).
 
 ## Progress
 

docs/.gitignore

@@ -0,0 +1 @@
+book

docs/book.toml

@@ -0,0 +1,10 @@
+[book]
+authors = ["The Fe Developers"]
+language = "en"
+multilingual = false
+src = "src"
+title = "The Fe Guide"
+
+[preprocessor.toc]
+command = "mdbook-toc"
+renderer = ["html"]

docs/src/SUMMARY.md

@@ -0,0 +1,13 @@
+# Summary
+
+[Introduction](index.md)
+
+* [Quickstart](quickstart/index.md)
+    * [Installation](quickstart/installation.md)
+    * [Write your first contract](quickstart/first_contract.md)
+* [Development](development/index.md)
+    * [Build & Test](development/build.md)
+    * [Release](development/release.md)
+* [Specification (WIP)](spec/index.md)
+* [Release Notes](release_notes.md)
+* [Code of Conduct](code_of_conduct.md)

docs/src/code_of_conduct.md

@@ -0,0 +1,133 @@
+
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+piper@pipermerriam.com.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+[https://www.contributor-covenant.org/version/2/0/code_of_conduct.html][v2.0].
+
+Community Impact Guidelines were inspired by 
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available 
+at [https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.0]: https://www.contributor-covenant.org/version/2/0/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

docs/build.md → docs/src/development/build.md

@@ -1,4 +1,4 @@
-# Build and test
+## Build and test
 
 Please make sure Rust is [installed](https://www.rust-lang.org/learn/get-started).
 
@@ -11,7 +11,7 @@ The following commands only build the Fe -> Yul compiler components.
 
 **Full**
 
-The Fe compiler depends on the Solidity compiler for transforming Yul IR to EVM bytecode. We currently use [solc-rust](https://github.com/axic/solc-rust) to perform this. In order to compile solc-rust, the following must be installed on your system:
+The Fe compiler depends on the Solidity compiler for transforming Yul IR to EVM bytecode. We currently use [solc-rust](https://github.com/g-r-a-n-t/solc-rust) to perform this. In order to compile solc-rust, the following must be installed on your system:
 
 - cmake
 - libboost

docs/src/development/index.md

@@ -0,0 +1,6 @@
+## Development
+
+Read how to become a Fe developer.
+
+* [Build & Test](build.md)
+* [Release](release.md)

docs/release.md → docs/src/development/release.md

@@ -1,12 +1,12 @@
-# Release
+## Release
 
-## Versioning
+### Versioning
 
 Make sure that version follows [semver](https://semver.org/) rules e.g (`0.2.0-alpha`).
 
 **For the time being, ALWAYS specify the `-alpha` suffix.**
 
-## Generate Release Notes
+### Generate Release Notes
 
 **Prerequisite**: Release notes are generated with [towncrier](https://pypi.org/project/towncrier/).Ensure to have `towncrier` installed and the command is available.
 
@@ -20,7 +20,7 @@ make notes version=0.2.0-alpha
 
 Examine the generated release notes and if needed perform and commit any manual changes.
 
-## Generate the release
+### Generate the release
 
 **Prerequisite**: Make sure the central repository is configured as `upstream`, **not** `origin`.
 
@@ -32,6 +32,6 @@ Example:
 make release version=0.2.0-alpha
 ```
 
-## Manually edit the release on GitHub
+### Manually edit the release on GitHub
 
 Running the previous command will push a new tag to Github and cause CI to create a [release](https://github.com/ethereum/fe/releases) with the Fe binaries attached. We may want to edit the release afterwards to put in some verbiage about the release.

docs/src/index.md

@@ -0,0 +1,3 @@
+# The Fe Guide
+
+<img alt="Fe logo" src="images/fe.png" height="300">

docs/src/quickstart/first_contract.md

@@ -0,0 +1,3 @@
+## Write your first Fe contract
+
+TODO

docs/src/quickstart/index.md

@@ -0,0 +1,6 @@
+## Quickstart
+
+Get started with Fe.
+
+* [Installation](installation.md)
+* [Writing your first contract](first_contract.md)

docs/src/quickstart/installation.md

@@ -0,0 +1,3 @@
+## Installation
+
+TODO

docs/release_notes.md → docs/src/release_notes.md

@@ -5,13 +5,14 @@
 [📄 Draft Spec](https://github.com/ethereum/fe/tree/master/spec)
 [ℹ️ Getting Started](https://github.com/ethereum/fe#getting-started)
 
+<!-- toc -->
 
 Fe is moving fast. Read up on all the latest improvements.
 
 **WARNING: All Fe releases are alpha releases and only meant to share the development progress with developers and enthusiasts. It is NOT yet ready for production usage.**
 
 [//]: # (towncrier release notes start)
-## 0.4.0-alpha (2021-04-28)## 0.4.0-alpha (2021-04-28)
+## 0.4.0-alpha (2021-04-28)
 
 
 ### Features