Skip to content

Commit

Permalink
Udpate structure of WIP website
Browse files Browse the repository at this point in the history
  • Loading branch information
lukewilliamboswell committed Jun 24, 2023
1 parent cfe528c commit ebac468
Show file tree
Hide file tree
Showing 12 changed files with 160 additions and 223 deletions.
118 changes: 0 additions & 118 deletions www/wip_new_website/content/blog/roc_website_2022.md

This file was deleted.

39 changes: 39 additions & 0 deletions www/wip_new_website/content/community_page.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# Contribute to Roc

## Community Values

<!--
Work in Progress - Richard is developing this section
Basically it will say something like we expect you to be kind, even if you think someone is being mean to you, don't assume ill intentions etc
-->

## Meet the Community

- Group Chat [roc.zulipchat.com](https://roc.zulipchat.com/)
- Github Project [roc-lang/roc](https://github.com/roc-lang/roc)
- Meetups & Events

## Ideas & Proposals

- [Good First Issues](https://github.com/roc-lang/roc/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22)

<!--
In this section we want to explain the process, i.e. it's less formal
TODO finish editing this section
-->

Roc doesn't have a formal process for managing design proposals. The guiding principal for now is that as a community we should all be friendly, supportive, and openly discuss and sharing ideas.

There are three loose stages that a design proposal can go through in Roc: Idea, Proposal, and Implementation.

In the Idea stage, people are encouraged to describe their idea and explore the problem, potential solutions, and trade-offs. It is helpful to share the idea in the group chat using the #ideas channel.

If there is a general consensus that an idea is promising and worth developing, people are encouraged to develop a design Proposal. Some ideas are simple and should progress straight to implementation. However, for more complex Proposals a it write the design into an article or blog post and share it online. This documentation helps in clarifying the proposal and making it more accessible to the community.

Implementation using PR...

## Code of Conduct

<!-- link to github goes here -->
25 changes: 0 additions & 25 deletions www/wip_new_website/content/contributing_page.md

This file was deleted.

44 changes: 44 additions & 0 deletions www/wip_new_website/content/design_goals.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@

# Design Goals

<!--
This page outlines at a high level of abstraction the design goals for Roc, and provides an assessment/overview of current progress
The three goals are Fast, Friendly, and Functional
- communicate the key selling points of Roc
- essence that sets the language apart
TODO move content from current home page, update for current progress
-->

# Fast

<!--
more universal appeal
don't take this for granted, drive this, it doesn't happen automatically
making lists of things -- maybe someday we can automatically optimise, we would like people to take the extra time to think about this
give people the tools to measure performance
benchmarking??
-->

# Friendly

<!--
encouraging community values - e.g. designing a library
immersed in the friendliness
testing??
-->

# Functional

<!--
if your already a fan
for others, some people find it unfamiliar and maybe even negative (don't assume this is automatically a positive) - don't worry
-->
36 changes: 0 additions & 36 deletions www/wip_new_website/content/discover_page.md

This file was deleted.

11 changes: 11 additions & 0 deletions www/wip_new_website/content/docs_page.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Documentation

- Builtin Package <!-- link to builtins -->
- Basic-CLI Platform <!-- link to docs -->

<!-- TODO Develop a Short language reference, move stuff out of tutorial e.g. de-sugaring table, keywords -->

## Guides

- [Frequently Asked Questions](https://github.com/roc-lang/roc/blob/main/FAQ.md)
- [Roc for Elm Programmers](https://github.com/roc-lang/roc/blob/main/roc-for-elm-programmers.md)
35 changes: 24 additions & 11 deletions www/wip_new_website/content/home_page.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,30 +4,43 @@ The purpose of the Home page is to function as the first point of contact for al
This page contains minimal content, so that visitors are able to quickly scan the page. It should not be cluttered or overwhelming. It should reflect Roc's goals (fast, friendly, functional) and values (welcoming community).
-->

# Roc lang

<!-- Explain Why Roc exists -->
# Roc lang{#page-title}

- fast
- friendly
- functional

<!-- These are only a minimal summary, link to the relevant section in design_goals.md -->

## Try Roc

<!-- WebREPL goes here, first impression -->

## [Discover Roc](/discover_page.html)
## Use cases (Roc applications)

<!-- I'm totally new to Roc, looks interesting, show me more -->
<!-- move to home page -->

## [Learn Roc](/learn_roc_page.html)
- Tools & Scripts
- Web (coming soon) <!-- richard starting on this -->
- Networking & Servers (coming soon)
- Graphical (coming soon)
- Scientific (coming soon)
- Embedded (coming soon)

<!-- I need to know more about Roc, show me where to find information -->
## Roc Platforms/Applications (vs libraries)

## [Contribute to Roc](contributing_page.html)
<!--
move to home page
explain as this is one of the most unique features of Roc
-->

<!-- I think the language and community are great, show me how to support Roc -->
## Talks and Publications

## [Getting Started](/getting_started_page.html)
<!-- move to end of home page -->

<!-- I want to use Roc, show me where to get the things I need -->
- Roc at Handmade Seattle - November 12, 2021 (very low-level explanation of how Roc's compiler makes programs run fast)
- Outperforming Imperative with Pure Functional Languages - October 1, 2021 (about Roc's runtime performance and optimizer)
- A taste of Roc - September 23, 2021 (syntax, application examples)
- Roc at the Philly ETE conference - May 6, 2021 (platforms and applications)
- Roc on Zig Showtime - April 24, 2021 (making a platform)
- Roc at the Berlin FP Meetup - September 1, 2020 (overall vision for the language)
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
# Getting Started

<!-- I want to use Roc, show me where to get the things I need -->
# Installing Roc

## Installation

Expand All @@ -12,9 +10,13 @@

## Nightly Builds

<!-- direct download links to builds go here -->

## Roc CLI

- Develop `roc dev`
<!-- brief description on how to use the cli -->
- Script `roc myApp.roc`
- Develop `roc dev`
- Test `roc test`
- Run `roc run`
- Build `roc build`
Expand All @@ -23,9 +25,24 @@

## Package Management

- URL Packages
<!--
explain package manager design is still a work in progress
the plan is to create a centralised index
- ergonomicly integration
- a fact that every language will have one
in the meantime you can use package URLs
-->

## Editor Support

<!--
explain that the high level design is a work in progress
- Design goals for editor - we want Roc to ship with an awesome editor
- Beginners learning to get up an running with an editor
- Want it to run really fast etc
-->

- Language Server
- Neo(Vim)
24 changes: 0 additions & 24 deletions www/wip_new_website/content/learn_roc_page.md

This file was deleted.

8 changes: 8 additions & 0 deletions www/wip_new_website/content/sponsor_page.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Sponsor

- [Github Sponsorship](https://github.com/sponsors/roc-lang)

<!--
1. link to github sponsor
2. have your company sponsor Roc
-->
5 changes: 5 additions & 0 deletions www/wip_new_website/content/tutorial_page.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Tutorial

This is a placeholder page for the Roc tutorial.

TODO move the tutorial here from `../generate_tutorial/src/input/tutorial.roc`
11 changes: 7 additions & 4 deletions www/wip_new_website/main.roc
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ view = \page, htmlContent ->
text htmlContent,
],
footer [] [
# <!-- TODO FOOTER - Lanugage link to source code -->
text "This site is powered by ",
a [href "https://www.netlify.com"] [ text "Netlify"],
text ". Made by people who like to make nice things. © Roc 2023",
Expand All @@ -64,10 +65,12 @@ viewNavbar =
rocLogo
],
div [id "top-bar-links"] [
a [href "/discover_page.html"] [text "discover"],
a [href "/learn_roc_page.html"] [text "learn"],
a [href "/contributing_page.html"] [text "contribute"],
a [href "/getting_started_page.html"] [text "getting started"],
a [href "/tutorial_page.html"] [text "tutorial"],
a [href "/install_page.html"] [text "install"],
a [href "#todo-link-to-examples-site"] [text "examples"],
a [href "/community_page.html"] [text "community"],
a [href "/sponsor_page.html"] [text "sponsor"],
a [href "/docs_page.html"] [text "docs"],
],
],
]
Expand Down

0 comments on commit ebac468

Please sign in to comment.