feat: cleanup docs

natesales · Jun 24, 2022 · 31f6aab · 31f6aab
1 parent e370082
commit 31f6aab
Show file tree

Hide file tree

Showing 7 changed files with 42 additions and 4 deletions.
diff --git a/docs/docs/cli.md b/docs/docs/cli.md
@@ -1,5 +1,5 @@
 ---
-title: CLI
+title: CLI Usage
 sidebar_position: 6
 ---
 # Usage

diff --git a/docs/docs/examples.md b/docs/docs/examples.md
@@ -1,5 +1,6 @@
 ---
 title: Examples
+sidebar_position: 5
 ---
 
 # Examples

diff --git a/docs/docs/integrations/_category_.json b/docs/docs/integrations/_category_.json
@@ -1,3 +1,4 @@
 {
-  "label": "Integrations"
+  "label": "Integrations",
+  "position": 11
 }
diff --git a/docs/docs/interactive.md b/docs/docs/interactive.md
@@ -1,4 +1,7 @@
-# Interactive CLI
+---
+title: Interactive CLI
+sidebar_position: 7
+---
 
 Pathvector supports an interactive CLI for configuration.
 

diff --git a/docs/docs/plugin.md → docs/docs/plugins.md b/docs/docs/plugin.md → docs/docs/plugins.md
diff --git a/docs/docs/v6.md b/docs/docs/v6.md
@@ -0,0 +1,33 @@
+---
+title: Version 6
+sidebar_position: 12
+---
+
+Pathvector 6 is the latest major revision and comes with some new features and breaking changes.
+
+## Features
+- [Interactive CLI](https://pathvector.io/docs/interactive)
+- [AS path filtering](https://pathvector.io/docs/filtering/irr)
+- [MRT support](https://pathvector.io/docs/configuration#https://pathvector.io/docs/configuration#mrtinstance)
+- [Template replacements](https://pathvector.io/docs/snippets)
+- [Extend plugin API to include custom commands](https://pathvector.io/docs/plugins)
+- [Export and receive limits](https://pathvector.io/docs/filtering/route-limits)
+- [Global config modification](https://pathvector.io/docs/configuration#global-config)
+- [Origin community tagging](https://pathvector.io/docs/configuration#origin-communities)
+- [Selective route announcement](https://pathvector.io/docs/configuration#dont-announce)
+- [BGP path reset](https://pathvector.io/docs/configuration#clear-path)
+- [BGP path modification](https://pathvector.io/docs/configuration#prepend-path)
+- [BGP hostname capability support](https://pathvector.io/docs/configuration#advertise-hostname)
+- [Peer on error control](https://pathvector.io/docs/configuration#disable-after-error)
+- [Configurable route selection tiebreaker](https://pathvector.io/docs/configuration#prefer-older-routes)
+
+## Breaking changes
+- Renamed `augments` to `kernel` and moved all kernel parameters to the `kernel` section
+- Added `Command` to plugin interface to support plugin commands
+- Rename `import-communities` => `add-on-import`, `export-communities` => `add-on-export`, and `announce-communities` => `announce`
+- Rename `cli` command to `birdsh` (`cli` is now the interactive CLI)
+
+## Enhancements
+- Process peers concurrently (a significant performance improvement)
+- Support both comma and colons community syntax
+- Minor bug fixes
diff --git a/docs/generate.sh b/docs/generate.sh
@@ -13,7 +13,7 @@ sidebar_position: 3
 
 echo Generating CLI preview
 echo -e '---
-title: CLI
+title: CLI Usage
 sidebar_position: 6
 ---\n# Usage\n```' >docs/docs/cli.md
 /tmp/pathvector -h >>docs/docs/cli.md