clean up and removing some boilerplate

rhyme-lang · Dec 12, 2023 · 0bfd29c · 0bfd29c
1 parent 87f0726
commit 0bfd29c
Show file tree

Hide file tree

Showing 12 changed files with 73 additions and 70 deletions.
diff --git a/content/en/_index.md b/content/en/_index.md
@@ -14,14 +14,16 @@ title: Rhyme
 
 
 {{% blocks/lead color="primary" %}}
-Goldydocs provides a single web UI providing visibility into porridge
-temperature, chair size, and bed softness metrics! You can even find out who's
-been eating **your** porridge.
 
+Rhyme is a new data-centric declarative query language designed for querying and
+transforming nested data structures.
+It is designed to be easy to use, and to be able to express multiple paradigms of
+workloads (typical data processing, visualizations, tensor computations, etc.) in a simple way while also being
+able to achieve performance by constructing an IR which gets optimized and translated to efficient JS code.
 
-(Sadly, Goldydocs isn't a real project, but you can use this site as an example
-to create your own real websites with [Docsy](https://docsy.dev))
-{{% /blocks/lead %}}
+
+
+<!-- {{% /blocks/lead %}}
 
 
 {{% blocks/section color="dark" type="row" %}}
@@ -74,4 +76,4 @@ For announcement of latest features etc.
 {{% blocks/section %}}
 This is the another section
 {.h1 .text-center}
-{{% /blocks/section %}}
+{{% /blocks/section %}} -->
diff --git a/content/en/blog/_index.md b/content/en/blog/_index.md
@@ -1,8 +1,8 @@
----
+<!-- ---
 title: Blog
 menu: {main: {weight: 30}}
 ---
 
 This is the **blog** section. It has two categories: News and Releases.
 
-Files in these directories will be listed in reverse chronological order.
+Files in these directories will be listed in reverse chronological order. -->
diff --git a/content/en/community/_index.md b/content/en/community/_index.md
@@ -1,6 +1,6 @@
----
+<!-- ---
 title: Community
 menu: {main: {weight: 40}}
 ---
 
-<!--add blocks of content here to add more sections to the community page -->
+add blocks of content here to add more sections to the community page -->
diff --git a/content/en/docs/_index.md b/content/en/docs/_index.md
@@ -5,10 +5,6 @@ menu: {main: {weight: 20}}
 weight: 20
 ---
 
-<!-- {{% pageinfo %}}
-This is a placeholder page that shows you how to use this template site.
-{{% /pageinfo %}} -->
-
 Welcome to the documentation of Rhyme! Here you will find information about various ways to use Rhyme,
 and some example use cases.
 Click on the links below to get started.
diff --git a/content/en/docs/examples/_index.md b/content/en/docs/examples/_index.md
@@ -3,10 +3,3 @@ title: Examples
 weight: 4
 description: Several example uses cases of Rhyme in action!
 ---
-
-{{% pageinfo %}}
-This is a placeholder page that shows you how to use this template site.
-{{% /pageinfo %}}
-
-Do you have any example **applications** or **code** for your users in your repo
-or elsewhere? Link to your examples here.
diff --git a/content/en/docs/examples/pivot.md b/content/en/docs/examples/pivot.md
@@ -1,13 +1,14 @@
 ---
 title: Pivot Tables
 description: >
-  A short lead description about this content page. It can be **bold** or _italic_ and can be split over multiple paragraphs.
-date: 2017-01-05
+  Shows how to use Rhyme to concisely create pivot tables from nested data and visualize them using Rhyme's graphics API.
+# date: 2017-01-05
 weight: 1
 ---
 
 {{% pageinfo %}}
-This is a placeholder page. Replace it with your own content.
+  <i class="fas fa-tools"></i>
+  Sorry, this page is still under construction.
 {{% /pageinfo %}}
 
-TODO: show the pivot table example from the blog
+<!-- TODO: show the pivot table example from the blog -->
diff --git a/content/en/docs/examples/tensor.md b/content/en/docs/examples/tensor.md
@@ -1,13 +1,15 @@
 ---
 title: Tensor Expressions
 description: >
-  A short lead description about this content page. It can be **bold** or _italic_ and can be split over multiple paragraphs.
+  Shows how to use Rhyme to express tensor computations in the style of Einstein notation and show
+  how to intermix tensor processing with other regular data processing.
 date: 2017-01-05
 weight: 3
 ---
 
 {{% pageinfo %}}
-This is a placeholder page. Replace it with your own content.
+  <i class="fas fa-tools"></i>
+  Sorry, this page is still under construction.
 {{% /pageinfo %}}
 
-TODO: tensor expression examples
+<!-- TODO: tensor expression examples -->
diff --git a/content/en/docs/frontends/_index.md b/content/en/docs/frontends/_index.md
@@ -5,5 +5,6 @@ weight: 3
 ---
 
 {{% pageinfo %}}
-JSON API is (currently) the primary API for Rhyme. It is the most expressive API right now. 
+JSON API is (currently) the primary API for Rhyme. It is the most expressive API right now.
+Please note that the documentation are under active development and may not be complete.
 {{% /pageinfo %}}
diff --git a/content/en/docs/frontends/graphics.md b/content/en/docs/frontends/graphics.md
@@ -7,7 +7,8 @@ weight: 3
 ---
 
 {{% pageinfo %}}
-This is a placeholder page. Replace it with your own content.
+  <i class="fas fa-tools"></i>
+  Sorry, this page is still under construction.
 {{% /pageinfo %}}
 
-TODO: describe the graphics API docs -- point to what is available, etc.
+<!-- TODO: describe the graphics API docs -- point to what is available, etc. -->
diff --git a/content/en/docs/frontends/pipe.md b/content/en/docs/frontends/pipe.md
@@ -9,7 +9,8 @@ weight: 2
 ---
 
 {{% pageinfo %}}
-This is a placeholder page. Replace it with your own content.
+  <i class="fas fa-tools"></i>
+  Sorry, this page is still under construction.
 {{% /pageinfo %}}
 
-TODO: describe the pipe API documentation
+<!-- TODO: describe the pipe API documentation -->
diff --git a/content/en/docs/getting-started/_index.md b/content/en/docs/getting-started/_index.md
@@ -91,3 +91,9 @@ npm install
 If you want to use the development version of the library you cloned in a different
 project, you can run `npm link` in the root directory of the repo and then run
 `npm link rhyme-lang` in your project directory.
+
+## Useful Links
+
+- Github repo can be found [here](https://github.com/rhyme-lang/rhyme-private)
+- An interactive blog introducing Rhyme can be found [here](https://tiarkrompf.github.io/notes/?/js-queries/).
+- An upcoming publication on Rhyme which is going to appear at PADL 2024 can be found [here](https://www.cs.purdue.edu/homes/rompf/papers/abeysinghe-padl24.pdf).
diff --git a/hugo.toml b/hugo.toml
@@ -66,12 +66,12 @@ anchor = "smart"
 # Everything below this are Site Params
 
 # Comment out if you don't want the "print entire section" link enabled.
-[outputs]
-section = ["HTML", "print", "RSS"]
+# [outputs]
+# section = ["HTML", "print", "RSS"]
 
 [params]
-copyright = "The Docsy Authors"
-privacy_policy = "https://policies.google.com/privacy"
+copyright = "Rhyme-lang Developers"
+# privacy_policy = "https://policies.google.com/privacy"
 
 # First one is picked as the Twitter card image if not set on page.
 # images = ["images/project-illustration.png"]
@@ -92,12 +92,12 @@ version = "0.0"
 
 # A link to latest version of the docs. Used in the "version-banner" partial to
 # point people to the main doc site.
-url_latest_version = "https://example.com"
+url_latest_version = "https://rhyme-lang.github.io/docs/"
 
 # Repository configuration (URLs for in-page links to opening issues and suggesting changes)
-github_repo = "https://github.com/google/docsy-example"
+github_repo = "https://github.com/rhyme-lang/rhyme-lang.github.io"
 # An optional link to a related project repo. For example, the sibling repository where your product code lives.
-github_project_repo = "https://github.com/google/docsy"
+github_project_repo = "https://github.com/rhyme-lang/rhyme"
 
 # Specify a value here if your content directory is not in your repo's root directory
 # github_subdir = ""
@@ -113,7 +113,7 @@ github_branch= "main"
 offlineSearch = false
 
 # Enable syntax highlighting and copy buttons on code blocks with Prism
-prism_syntax_highlighting = false
+prism_syntax_highlighting = true
 
 # User interface configuration
 [params.ui]
@@ -122,7 +122,7 @@ breadcrumb_disable = false
 # Set to true to disable the About link in the site footer
 footer_about_disable = false
 # Set to false if you don't want to display a logo (/assets/icons/logo.svg) in the top navbar
-navbar_logo = true
+navbar_logo = false
 # Set to true if you don't want the top navbar to be translucent when over a `block/cover`, like on the homepage.
 navbar_translucent_over_cover_disable = false
 # Enable to show the side bar menu in its compact state.
@@ -135,7 +135,7 @@ sidebar_search_disable = false
 # If you want this feature, but occasionally need to remove the "Feedback" section from a single page,
 # add "hide_feedback: true" to the page's front matter.
 [params.ui.feedback]
-enable = true
+enable = false
 # The responses that the user sees after clicking "yes" (the page was helpful) or "no" (the page was not helpful).
 yes = 'Glad to hear it! Please <a href="https://github.com/USERNAME/REPOSITORY/issues/new">tell us how we can improve</a>.'
 no = 'Sorry to hear that. Please <a href="https://github.com/USERNAME/REPOSITORY/issues/new">tell us how we can improve</a>.'
@@ -148,37 +148,37 @@ enable = false
 
 [params.links]
 # End user relevant links. These will show up on left side of footer and in the community page if you have one.
-[[params.links.user]]
-  name = "User mailing list"
-  url = "https://example.org/mail"
-  icon = "fa fa-envelope"
-  desc = "Discussion and help from your fellow users"
-[[params.links.user]]
-  name ="Twitter"
-  url = "https://example.org/twitter"
-  icon = "fab fa-twitter"
-  desc = "Follow us on Twitter to get the latest news!"
-[[params.links.user]]
-  name = "Stack Overflow"
-  url = "https://example.org/stack"
-  icon = "fab fa-stack-overflow"
-  desc = "Practical questions and curated answers"
+#[[params.links.user]]
+#  name = "User mailing list"
+#  url = "https://example.org/mail"
+#  icon = "fa fa-envelope"
+#  desc = "Discussion and help from your fellow users"
+#[[params.links.user]]
+#  name ="Twitter"
+#  url = "https://example.org/twitter"
+#  icon = "fab fa-twitter"
+#  desc = "Follow us on Twitter to get the latest news!"
+#[[params.links.user]]
+#  name = "Stack Overflow"
+#  url = "https://example.org/stack"
+#  icon = "fab fa-stack-overflow"
+#  desc = "Practical questions and curated answers"
 # Developer relevant links. These will show up on right side of footer and in the community page if you have one.
 [[params.links.developer]]
   name = "GitHub"
-  url = "https://github.com/google/docsy"
+  url = "https://github.com/rhyme-lang/rhyme"
   icon = "fab fa-github"
   desc = "Development takes place here!"
-[[params.links.developer]]
-  name = "Slack"
-  url = "https://example.org/slack"
-  icon = "fab fa-slack"
-  desc = "Chat with other project developers"
-[[params.links.developer]]
-  name = "Developer mailing list"
-  url = "https://example.org/mail"
-  icon = "fa fa-envelope"
-  desc = "Discuss development issues around the project"
+#[[params.links.developer]]
+#  name = "Slack"
+#  url = "https://example.org/slack"
+#  icon = "fab fa-slack"
+#  desc = "Chat with other project developers"
+#[[params.links.developer]]
+#  name = "Developer mailing list"
+#  url = "https://example.org/mail"
+#  icon = "fa fa-envelope"
+#  desc = "Discuss development issues around the project"
 
 # hugo module configuration