chore: rearchtect the docs

protoconf · Jun 8, 2024 · 8adc7de · 8adc7de
1 parent 85bb64f
commit 8adc7de
Show file tree

Hide file tree

Showing 22 changed files with 27 additions and 16 deletions.
diff --git a/docs/advanced-usage/_category_.json → docs/composing/_category_.json b/docs/advanced-usage/_category_.json → docs/composing/_category_.json
@@ -1,6 +1,6 @@
 {
-  "label": "Advanced Usage",
-  "position": 5,
+  "label": "Composing",
+  "position": 3,
   "link": {
     "type": "generated-index",
     "description": "Learn more advanced techniques to use protoconf."

diff --git a/docs/advanced-usage/code-reuse.mdx → docs/composing/code-reuse.mdx b/docs/advanced-usage/code-reuse.mdx → docs/composing/code-reuse.mdx
diff --git a/docs/advanced-usage/multiple-outputs.mdx → docs/composing/multiple-outputs.mdx b/docs/advanced-usage/multiple-outputs.mdx → docs/composing/multiple-outputs.mdx
diff --git a/.../advanced-usage/mutation-service/grpc.mdx → docs/composing/mutation-service/grpc.mdx b/.../advanced-usage/mutation-service/grpc.mdx → docs/composing/mutation-service/grpc.mdx
diff --git a/...d-usage/mutation-service/mutation-cli.mdx → ...mposing/mutation-service/mutation-cli.mdx b/...d-usage/mutation-service/mutation-cli.mdx → ...mposing/mutation-service/mutation-cli.mdx
diff --git a/...age/mutation-service/mutation-service.mdx → ...ing/mutation-service/mutation-service.mdx b/...age/mutation-service/mutation-service.mdx → ...ing/mutation-service/mutation-service.mdx
diff --git a/...ced-usage/mutation-service/reflection.mdx → ...composing/mutation-service/reflection.mdx b/...ced-usage/mutation-service/reflection.mdx → ...composing/mutation-service/reflection.mdx
diff --git a/docs/advanced-usage/output-formats.mdx → docs/composing/output-formats.mdx b/docs/advanced-usage/output-formats.mdx → docs/composing/output-formats.mdx
diff --git a/docs/advanced-usage/pipelining.mdx → docs/composing/pipelining.mdx b/docs/advanced-usage/pipelining.mdx → docs/composing/pipelining.mdx
diff --git a/docs/advanced-usage/protobuf-any.mdx → docs/composing/protobuf-any.mdx b/docs/advanced-usage/protobuf-any.mdx → docs/composing/protobuf-any.mdx
diff --git a/docs/advanced-usage/starlib.mdx → docs/composing/starlib.mdx b/docs/advanced-usage/starlib.mdx → docs/composing/starlib.mdx
diff --git a/docs/consuming/_category_.json b/docs/consuming/_category_.json
@@ -0,0 +1,4 @@
+{
+  "label": "Consuming",
+  "position": 5
+}
diff --git a/docs/production/running-in-production.mdx → docs/consuming/running-in-production.mdx b/docs/production/running-in-production.mdx → docs/consuming/running-in-production.mdx
diff --git a/docs/delivering/_category_.json b/docs/delivering/_category_.json
@@ -0,0 +1,4 @@
+{
+  "label": "Delivering",
+  "position": 4
+}
diff --git a/docs/production/inserting-configurations.mdx → docs/delivering/inserting-configurations.mdx b/docs/production/inserting-configurations.mdx → docs/delivering/inserting-configurations.mdx
diff --git a/docs/consume-config-updates.mdx → ...etting-started/consume-config-updates.mdx b/docs/consume-config-updates.mdx → ...etting-started/consume-config-updates.mdx
@@ -13,21 +13,19 @@ protoconf provides a gRPC service that allows your application to subscribe to c
 
 This guide will walk you through how to subscribe to configuration updates using the protoconf agent in various languages: Go, Python, Node.js, Rust, and Java.
 
-## protoconf Agent
+## protoconf Dev server
 
-To start the protoconf agent in development mode, use the following command:
+To start protoconf in development mode, use the following command:
 
 ```bash
-protoconf agent -dev .
+protoconf devserver .
 ```
 
-The protoconf agent implements the following gRPC service:
+The protoconf agent implements the following gRPC service ([See full proto file](https://github.com/protoconf/protoconf/blob/main/pb/protoconf/v1/protoconf.proto#L66)):
 
 ```protobuf
 syntax = "proto3";
-package v1;
-
-option java_package = "com.protoconf.agent.api.v1";
+package protoconf.v1;
 
 import "google/protobuf/any.proto";
 

diff --git a/docs/getting-started.mdx → docs/getting-started/getting-started.mdx b/docs/getting-started.mdx → docs/getting-started/getting-started.mdx
diff --git a/docs/production/production-architecture.mdx → ...tting-started/production-architecture.mdx b/docs/production/production-architecture.mdx → ...tting-started/production-architecture.mdx
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 1
+sidebar_position: 4
 ---
 
 # Production Architecture

diff --git a/docs/validation.mdx → docs/getting-started/validation.mdx b/docs/validation.mdx → docs/getting-started/validation.mdx
diff --git a/docs/production/_category_.json b/docs/production/_category_.json
diff --git a/docusaurus.config.js b/docusaurus.config.js
@@ -53,6 +53,9 @@ const config = {
           versions: {
             current: {
               label: 'v0.2.0',
+            },
+            "0.1.7": {
+              label: 'v0.1.7',
             }
           }
         },
@@ -83,6 +86,12 @@ const config = {
           srcDark: 'img/protoconf_inverse.png',
         },
         items: [
+          {
+            type: 'doc',
+            docId: 'getting-started/getting-started',
+            position: 'left',
+            label: 'Get Started',
+          },
           {
             type: 'doc',
             docId: 'intro',
@@ -146,7 +155,7 @@ const config = {
             items: [
               {
                 label: 'Tutorial',
-                to: 'docs/0.1.7/intro',
+                to: 'docs/intro',
               },
             ],
           },

diff --git a/src/pages/index.tsx b/src/pages/index.tsx
@@ -17,7 +17,7 @@ function HomepageHeader() {
         <div className={styles.buttons}>
           <Link
             className="button button--secondary button--lg"
-            to="/docs/0.1.7/intro">
+            to="/docs/intro">
             Getting Started
           </Link>
         </div>