feat(docs): add vuepress and refactor docs structure

.github/workflows/ci.yml

@@ -224,6 +224,24 @@ jobs:
           cd cmd
           ../bin/goreleaser
 
+  docs:
+    name: Build and deploy docs
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v1
+
+    - name: Build docs
+      run: yarn && yarn docs:build
+
+    - name: Deploy
+      uses: peaceiris/actions-gh-pages@v3
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        publish_dir: docs/.vuepress/dist
+        publish_branch: gh-pages-test
+        keep_files: true
+
   deploy:
     name: Deploy
     runs-on: ubuntu-latest

.gitignore

@@ -17,20 +17,25 @@ debug
 *.txt
 !requirements.txt
 
-# build directories
+# Build directories
 dist/*
 cmd/dist/*
 tools/dist/*
+docs/*/dist/*
 
 bin/*
 cmd/bin/*
 tools/bin/*
 
 # Vendor
 vendor
+node_modules
 
 # Local testing
 .local
 
 # Infrastructure
-infrastructure/.pyenv
+infrastructure/*/.terraform/
+infrastructure/*/ssh/id_rsa
+infrastructure/*/.envrc.local
+infrastructure/*/.pyenv

.npmignore

@@ -0,0 +1,12 @@
+pids
+logs
+node_modules
+npm-debug.log
+coverage/
+run
+dist
+.DS_Store
+.nyc_output
+.basement
+config.local.js
+basement_dist

config.toml

@@ -0,0 +1,44 @@
+baseURL = "nimona.io"
+languageCode = "en-us"
+title = "nimona"
+themesDir = ".github/themes"
+theme = "hugo-whisper-theme"
+
+pygmentsCodeFences = true
+pygmentsCodefencesGuessSyntax = true
+pygmentsUseClasses = true
+
+summaryLength = 30
+
+[[menu.main]]
+    name = "Home"
+    url = "/"
+    weight = 1
+
+[[menu.main]]
+    name = "Docs"
+    url = "/docs/"
+    weight = 2
+
+[params]
+  google_analytics_id=""
+  homepage_button_link = '/docs'
+  homepage_button_text = 'Read The Docs'
+  homepage_intro = 'Whisper is a documentation theme built with Hugo. The design and functionality is intentionally minimal.'
+  homepage_image = '/images/terminal.gif'
+  enable_anchor_link = false
+
+  [params.homepage_meta_tags]
+    meta_description = "Hugo Whisper is a documentation theme built with Hugo."
+    meta_og_title = "Hugo Whisper Theme"
+    meta_og_type = "website"
+    meta_og_url = "https://hugo-whisper.netlify.app"
+    meta_og_image = "https://raw.githubusercontent.com/JugglerX/hugo-whisper-theme/master/images/tn.png"
+    meta_og_description = "Hugo Whisper is a documentation theme built with Hugo."
+    meta_twitter_card = "summary"
+    meta_twitter_site = "@zerostaticio"
+    meta_twitter_creator = "@zerostaticio"
+
+  [params.logo]
+      mobile = "/images/nimona-logo-icon.png"
+      standard  = "/images/nimona-logo-icon.png"

docs/.vuepress/config.js

@@ -0,0 +1,56 @@
+module.exports = {
+  title: 'nimona',
+  description: 'a new internet stack, or something like it',
+  themeConfig: {
+    navbar: false,
+    // logo: '/nimona-logo.png',
+    search: true,
+    nav: [
+      { text: 'Home', link: '/' },
+      { text: 'Concepts', link: '/concepts/' },
+      { text: 'Proposals', link: '/proposals/' },
+    ],
+    sidebar: [{
+      title: 'Nimona',
+      path: '/introduction',
+      collapsable: false,
+      children: [
+        '/design-decisions',
+      ],
+    }, {
+      title: 'Concepts',
+      collapsable: false,
+      children: [
+        '/networking',
+        {
+          title: 'Objects',
+          path: '/objects',
+          collapsable: false,
+          children: [[
+            '/proposals/np001-hinted-object-notation',
+            'Hinting & Hashing [np001]',
+          ], [
+            '/proposals/np002-structured-objects',
+            'Structure [np002]',
+          ]],
+          sidebarDepth: 0,
+        },
+        [
+          '/proposals/np003-streams',
+          'Streams [np003]',
+        ],
+        [
+          '/proposals/np004-feeds',
+          'Feeds [np004]',
+        ],
+      ],
+    }, {
+      title: 'Other',
+      collapsable: false,
+      children: [
+        '/proposals/',
+      ],
+    }],
+    displayAllHeaders: true,
+  }
+}

docs/.vuepress/styles/palette.styl

@@ -0,0 +1,20 @@
+// colors
+$accentColor = #F652A0
+$textColor = #2c3e50
+$borderColor = #eaecef
+$codeBgColor = #282c34
+$arrowBgColor = #ccc
+$badgeTipColor = #42b983
+$badgeWarningColor = darken(#ffe564, 35%)
+$badgeErrorColor = #DA5961
+
+// layout
+$navbarHeight = 3.6rem
+$sidebarWidth = 20rem
+$contentWidth = 740px
+$homePageWidth = 960px
+
+// responsive breakpoints
+$MQNarrow = 959px
+$MQMobile = 719px
+$MQMobileNarrow = 419px

docs/README.md

@@ -1,52 +1,3 @@
-# Nimona
-
-Nimona’s aim is to create a data-centric network that enables users to use
-compatible applications to create and share data without being restricted
-to the application that created them or having to force other users to use
-the same application to access them. Users are always in control of their
-relationships, their data, and who they share them with.
-
-It provides a number of very opinionated layers from networking, communication,
-and identity management; to application level layers for managing permissioned
-static or dynamic data.
-
-Often users will move between services or use multiple services at the same
-time that provide similar amenities either because of missing features or in
-order to be able to share data with users that prefer (or simply just ended
-up on) another service.
-Over time most of these services will get abandoned by their developers or
-users, will change into something else, or simply die off.
-This results in data and relationships being left behind and eventually lost.
-
-## Identity
-
-Users get an identity they can use across multiple applications and services.
-Your identity belongs to you and you control who can access what information
-in your profile.
-You can use your identity in any compatible application.
-
-Your friends and other people you communicate with also don’t usually change.
-All your relationships come with your identity no matter which application you
-are using.
-
-## Interoperability
-
-Applications can create, manage and share data that can be used by other
-compatible applications.
-Alice can send messages to Bob without having to know or care what messaging
-application Bob uses.
-An initial registry of common data types allows compatible applications to
-exchange data between them, extend the existing types, or create new ones if
-they need to.
-
-## Ownership
-
-The data you create, ie articles, conversations, photos and status updates,
-are only shared with the people that you give access, or you can decide to
-make some of them publicly accessible.
-
-Data are stored either on the devices where your applications are installed,
-or online services you have authorized to hold a copy of your data.
-When you authorize a new application and give it access to your data, it will
-be able to talk with any other services that have access to the same data,
-and retrieve the data it needs.
+---
+layout: Blue
+---