Docs

firelizzard18 · Nov 20, 2024 · 700dcff · 700dcff
1 parent d478def
commit 700dcff
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 3 deletions.
diff --git a/.editorconfig b/.editorconfig
@@ -0,0 +1,5 @@
+root = true
+
+[*.{ts,js}]
+indent_size = 4
+indent_style = tab
diff --git a/README.md b/README.md
@@ -50,7 +50,12 @@ To profile tests:
 If multiple tests are run with profiling enabled, `Profiles` will appear under
 the package instead of the individual test.
 
-## Documentation Viewer (**TODO**)
+![cpu-pprof](./docs/assets/cpu-pprof.png)
 
-I plan to add an in-editor documentation viewer such that you can view
-documentation for your code similar to what you would see on pkg.go.dev.
+## Documentation Viewer
+
+Go Companion provides a command and editor context menu item for rendering
+package documentation. Right click a declaration in a Go file and select "Go
+Companion: Render Documentation":
+
+![doc-viewer](./docs/assets/doc-viewer.png)
diff --git a/docs/assets/cpu-pprof.png b/docs/assets/cpu-pprof.png
diff --git a/docs/assets/doc-viewer.png b/docs/assets/doc-viewer.png