docs: guides, landing page and verbiage updates

Co-authored-by: Tasos Bitsios <[email protected]> Co-authored-by: Larkin Young <[email protected]> Co-authored-by: Kyle Breeding <[email protected]>
algorandfoundation · Jan 14, 2025 · 5f9ff86 · 5f9ff86
1 parent 54391f3
commit 5f9ff86
Show file tree

Hide file tree

Showing 45 changed files with 1,056 additions and 957 deletions.
diff --git a/.DS_Store b/.DS_Store
diff --git a/.github/workflows/CD.yaml b/.github/workflows/CD.yaml
@@ -24,11 +24,11 @@ jobs:
           GOOS: ${{matrix.goos}}
           GOARCH: ${{matrix.goarch}}
           CGO_ENABLED: 0
-        run: go build -o bin/algorun-${{matrix.goarch}}-${{matrix.goos}} *.go
+        run: go build -o bin/nodekit-${{matrix.goarch}}-${{matrix.goos}} *.go
       - uses: actions/upload-artifact@master
         with:
-          name: algorun-${{matrix.goarch}}-${{matrix.goos}}
-          path: bin/algorun-${{matrix.goarch}}-${{matrix.goos}}
+          name: nodekit-${{matrix.goarch}}-${{matrix.goos}}
+          path: bin/nodekit-${{matrix.goarch}}-${{matrix.goos}}
   release:
     needs: 
       - build
@@ -37,7 +37,7 @@ jobs:
       - uses: actions/checkout@v4
       - uses: actions/download-artifact@v4
         with:
-          pattern: algorun*
+          pattern: nodekit*
           path: ./bin
       - uses: go-semantic-release/action@v1
         name: release
@@ -47,4 +47,4 @@ jobs:
       - name: Upload Release
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        run: gh release upload v${{steps.semver.outputs.version}} bin/**/*
+        run: gh release upload v${{steps.semver.outputs.version}} bin/**/*
diff --git a/cmd/configure/configure.go b/cmd/configure/configure.go
@@ -55,7 +55,7 @@ func configureNode() error {
 
 	// Check systemctl first
 	if algod.IsService() {
-		if promptWrapperYes("Algorand is installed as a service. Do you wish to edit the service file to change the data directory? (y/n)") {
+		if promptWrapperYes("Algorand is installed as a service. Do you wish to edit the service file to change the data directory? (y/N)") {
 			// Edit the service file with the user's new data directory
 			systemServiceConfigure = true
 		} else {
@@ -84,18 +84,18 @@ func configureNode() error {
 			fmt.Println("Found valid Algorand Data Directory: " + algorandData)
 
 			if systemServiceConfigure {
-				if promptWrapperYes("Would you like to set the ALGORAND_DATA env variable as the data directory for the systemd Algorand service? (y/n)") {
+				if promptWrapperYes("Would you like to set the ALGORAND_DATA env variable as the data directory for the systemd Algorand service? (y/N)") {
 					editAlgorandServiceFile(algorandData)
 					os.Exit(0)
 				}
 			}
 
-			if promptWrapperNo("Do you want to set a completely new data directory? (y/n)") {
+			if promptWrapperNo("Do you want to set a completely new data directory? (y/N)") {
 				fmt.Println("User chose not to set a completely new data directory.")
 				os.Exit(0)
 			}
 
-			if promptWrapperYes("Do you want to manually input the new data directory? (y/n)") {
+			if promptWrapperYes("Do you want to manually input the new data directory? (y/N)") {
 				newPath := promptWrapperInput("Enter the new data directory path")
 
 				if !validateAlgorandDataDir(newPath) {
@@ -130,7 +130,7 @@ func configureNode() error {
 		}
 
 		if len(paths) == 1 {
-			if promptWrapperYes("Do you want to set this directory as the new data directory? (y/n)") {
+			if promptWrapperYes("Do you want to set this directory as the new data directory? (y/N)") {
 				if systemServiceConfigure {
 					// Edit the service file
 					editAlgorandServiceFile(paths[0])
@@ -142,7 +142,7 @@ func configureNode() error {
 
 		} else {
 
-			if promptWrapperYes("Do you want to set one of these directories as the new data directory? (y/n)") {
+			if promptWrapperYes("Do you want to set one of these directories as the new data directory? (y/N)") {
 
 				selectedPath := promptWrapperSelection("Select an Algorand data directory", paths)
 
@@ -158,12 +158,12 @@ func configureNode() error {
 	}
 
 	// Deep search
-	if promptWrapperNo("Do you want NodeKit to do a deep search for pre-existing Algorand Data directories? (y/n)") {
-		fmt.Println("User chose not to search for more pre-existing Algorand Data directories. Exiting...")
+	if promptWrapperNo("Do you want NodeKit to do a deep search for pre-existing Algorand data directories? (y/N)") {
+		fmt.Println("User chose not to search for more pre-existing Algorand data directories. Exiting...")
 		os.Exit(0)
 	}
 
-	fmt.Println("Searching for pre-existing Algorand Data directories in HOME directory...")
+	fmt.Println("Searching for pre-existing Algorand data directories in HOME directory...")
 	paths = deepSearchAlgorandDataDirs()
 
 	if len(paths) == 0 {

diff --git a/docs/.nvmrc b/docs/.nvmrc
@@ -0,0 +1 @@
+v20.11.0
diff --git a/docs/astro.config.mjs b/docs/astro.config.mjs
@@ -1,36 +1,42 @@
 // @ts-check
-import { defineConfig } from 'astro/config';
-import starlight from '@astrojs/starlight';
-import tailwind from '@astrojs/tailwind';
+import { defineConfig } from "astro/config";
+import starlight from "@astrojs/starlight";
+import tailwind from "@astrojs/tailwind";
 
 // https://astro.build/config
 export default defineConfig({
-	integrations: [
-		starlight({
-			title: 'NodeKit',
-			logo: {
-				src: './public/nodekit.png',
-				replacesTitle: true,
-			},
-			social: {
-				github: 'https://github.com/algorandfoundation/nodekit',
-			},
-			sidebar: [
-				// {
-				// 	label: 'Guides',
-				// 	items: [
-				// 		// Each item here is one entry in the navigation menu.
-				// 		{ label: 'Example Guide', slug: 'guides/example' },
-				// 	],
-				// },
-				{
-					label: 'Reference',
-					// collapsed: true,
-					autogenerate: { directory: 'reference' },
-				},
-			],
-			customCss: ['./src/tailwind.css'],
-		}),
-		tailwind({ applyBaseStyles: true }),
-	],
+  integrations: [
+    starlight({
+      title: "NodeKit",
+      logo: {
+        light: "./public/nodekit-light.png",
+        dark: "./public/nodekit-dark.png",
+        alt: "NodeKit for Algorand",
+        replacesTitle: true,
+      },
+      social: {
+        github: "https://github.com/algorandfoundation/nodekit",
+      },
+      sidebar: [
+        {
+          label: "Guides",
+          autogenerate: { directory: "guides" },
+        },
+        {
+          label: "Troubleshooting",
+          link: "/troubleshooting",
+        },
+        {
+          label: "Command Reference",
+          collapsed: true,
+          autogenerate: { directory: "reference" },
+        },
+      ],
+      components: {
+        ThemeProvider: "./src/components/CustomThemeProvider.astro",
+      },
+      customCss: ["./src/tailwind.css"],
+    }),
+    tailwind({ applyBaseStyles: true }),
+  ],
 });
diff --git a/docs/ec.config.mjs b/docs/ec.config.mjs
@@ -0,0 +1,10 @@
+import { pluginLineNumbers } from '@expressive-code/plugin-line-numbers';
+import mocha from '@catppuccin/vscode/themes/mocha.json' with {type: 'json'}
+import latte from '@catppuccin/vscode/themes/latte.json' with {type: 'json'}
+import fs from 'node:fs';
+
+/** @type {import('@astrojs/starlight/expressive-code').StarlightExpressiveCodeOptions} */
+export default {
+  plugins: [pluginLineNumbers()],
+  themes: [latte, mocha],
+};