Update docs for 0.2.0

ctjdr · Nov 27, 2020 · 5bc0497 · 5bc0497
1 parent f2f8879
commit 5bc0497
Show file tree

Hide file tree

Showing 10 changed files with 197 additions and 21 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,17 @@
 # Changelog
 
+## 0.2.0 (2020-11-27)
+
+**Enhancements**
+
+- Activate extension only when manifest.json file present in workspace [\#9](https://github.com/ctjdr/vscode-apprt-bundles/issues/9)
+- Indicate extension startup in status bar [\#8](https://github.com/ctjdr/vscode-apprt-bundles/issues/8)
+
+**Bug fixes**
+
+- Use webpack to bundle extension [\#10](https://github.com/ctjdr/vscode-apprt-bundles/issues/10)
+
+
 ## 0.1.0 (2020-11-06)
 
 **Enhancements**

diff --git a/docs/Gemfile b/docs/Gemfile
@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+# gem 'nokogiri'
+# gem 'rack', '~> 2.0.1'
+# gem 'rspec'
+
+gem "just-the-docs"
+gem "jemoji"
diff --git a/docs/Gemfile.lock b/docs/Gemfile.lock
@@ -0,0 +1,97 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.0.3.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    colorator (1.1.0)
+    concurrent-ruby (1.1.7)
+    em-websocket (0.5.2)
+      eventmachine (>= 0.12.9)
+      http_parser.rb (~> 0.6.0)
+    eventmachine (1.2.7)
+    ffi (1.13.1)
+    forwardable-extended (2.6.0)
+    gemoji (3.0.1)
+    html-pipeline (2.14.0)
+      activesupport (>= 2)
+      nokogiri (>= 1.4)
+    http_parser.rb (0.6.0)
+    i18n (1.8.5)
+      concurrent-ruby (~> 1.0)
+    jekyll (4.1.1)
+      addressable (~> 2.4)
+      colorator (~> 1.0)
+      em-websocket (~> 0.5)
+      i18n (~> 1.0)
+      jekyll-sass-converter (~> 2.0)
+      jekyll-watch (~> 2.0)
+      kramdown (~> 2.1)
+      kramdown-parser-gfm (~> 1.0)
+      liquid (~> 4.0)
+      mercenary (~> 0.4.0)
+      pathutil (~> 0.9)
+      rouge (~> 3.0)
+      safe_yaml (~> 1.0)
+      terminal-table (~> 1.8)
+    jekyll-sass-converter (2.1.0)
+      sassc (> 2.0.1, < 3.0)
+    jekyll-seo-tag (2.7.1)
+      jekyll (>= 3.8, < 5.0)
+    jekyll-watch (2.2.1)
+      listen (~> 3.0)
+    jemoji (0.12.0)
+      gemoji (~> 3.0)
+      html-pipeline (~> 2.2)
+      jekyll (>= 3.0, < 5.0)
+    just-the-docs (0.3.3)
+      jekyll (>= 3.8.5)
+      jekyll-seo-tag (~> 2.0)
+      rake (>= 12.3.1, < 13.1.0)
+    kramdown (2.3.0)
+      rexml
+    kramdown-parser-gfm (1.1.0)
+      kramdown (~> 2.0)
+    liquid (4.0.3)
+    listen (3.3.1)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    mercenary (0.4.0)
+    mini_portile2 (2.4.0)
+    minitest (5.14.2)
+    nokogiri (1.10.10)
+      mini_portile2 (~> 2.4.0)
+    pathutil (0.16.2)
+      forwardable-extended (~> 2.6)
+    public_suffix (4.0.6)
+    rake (13.0.1)
+    rb-fsevent (0.10.4)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    rexml (3.2.4)
+    rouge (3.25.0)
+    safe_yaml (1.0.5)
+    sassc (2.4.0)
+      ffi (~> 1.9)
+    terminal-table (1.8.0)
+      unicode-display_width (~> 1.1, >= 1.1.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.8)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.7.0)
+    zeitwerk (2.4.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  jemoji
+  just-the-docs
+
+BUNDLED WITH
+   2.1.4
diff --git a/docs/images/feature_hover_pretty.png b/docs/images/feature_hover_pretty.png
diff --git a/docs/images/feature_statusbar_indexing.png b/docs/images/feature_statusbar_indexing.png
diff --git a/docs/index.md b/docs/index.md
@@ -5,35 +5,32 @@ nav_exclude: false
 nav_order: 1
 ---
 
-Version [v0.1.0](updates/v0.1.0.md) was released on Nov, 7th 2020!
+Version [0.2.0](updates/v0.2.0.html) was released on Nov, 27th 2020!
 {: .fs-4 .fw-700}
 
 # Visual Studio Code extension for apprt bundles
 
 This extension supports you writing and navigating *manifest.json* files plus working with bundles in general.
 
-For a comprehensive list of what this tool can do for you, have a look at the [table of features](FEATURES.md). 
+For a comprehensive list of what this tool can do for you, have a look at the [table of features](features/manifest-editing.html). 
 
 ![Features Demo](images/demo.gif)
 
 ## Using the extension
 
-1. Install the extension, either from the Extension view directly from inside VS Code or downloading the `vsix` extension file release from this site.
+1. Install the extension, either 
+   * from the Extension view **directly from inside VS Code**, or
+   * [**downloading**](https://github.com/ctjdr/vscode-apprt-bundles/releases) the `vsix` extension file release from this site.
 2. Open a project containing `manifest.json` files.
-3. Take advantage of the features described below.
-
+3. Take advantage of its [features](../features/manifest-editing.html).
 ## Updates & changes
 
 
-* [New in 0.1.0](updates/v0.1.0.md)
-
-Visit the [changelog](CHANGELOG.md) to get all details about changes for a version. 
-
+* [New in 0.2.0](updates/v0.2.0.html)
+* [New in 0.1.0](updates/v0.1.0.html)
 
-## Upcoming
+Visit the [changelog](updates/CHANGELOG.html) to get all details about changes for a version. 
 
-* Bundle navigation: Jump to the manifest of a bundle when clicking on an entry in the `"dependencies"` section of a manifest.
-* Rename service names: Hit `F2` and rename all occurances of a service name
 
 ## Further ideas
 

diff --git a/docs/updates/CHANGELOG.md b/docs/updates/CHANGELOG.md
@@ -2,10 +2,23 @@
 layout: default
 title: Changelog
 parent: Updates
-nav_order: 100
+nav_order: 1000
 ---
 # Changelog
 
+## 0.2.0 (2020-11-27)
+
+**Enhancements**
+
+- Activate extension only when manifest.json file present in workspace [\#9](https://github.com/ctjdr/vscode-apprt-bundles/issues/9)
+- Indicate extension startup in status bar [\#8](https://github.com/ctjdr/vscode-apprt-bundles/issues/8)
+
+**Bug fixes**
+
+- Use webpack to bundle extension [\#10](https://github.com/ctjdr/vscode-apprt-bundles/issues/10)
+
+
+
 ## 0.1.0 (2020-11-06)
 
 **Enhancements**

diff --git a/docs/updates/v0.0.x.md b/docs/updates/v0.0.x.md
@@ -1,10 +1,10 @@
 ---
 layout: default
-title: v0.0.5 and earlier
+title: 0.0.5 and earlier
 parent: Updates
-nav_order: 2
+nav_order: 990
 ---
-# v0.0.5 and earlier
+# 0.0.5 and earlier
 
 Version 0.0.x brings these new features:
 
@@ -16,4 +16,4 @@ Version 0.0.x brings these new features:
 * **[Service name completion]()** - Suggest service names when adding a 'provides' or 'providing' value.
 * **[Navigate service providers and consumer]()** - Display code lense to quicky jump to a consumer or provider of a service.
 
-Additionally, find all fixed issues in the [changelog](/CHANGELOG.md).
+Additionally, find all fixed issues in the [changelog](CHANGELOG.html).
diff --git a/docs/updates/v0.1.0.md b/docs/updates/v0.1.0.md
@@ -1,17 +1,17 @@
 ---
 layout: default
-title: v0.1.0
+title: 0.1.0
 parent: Updates
-nav_order: 1
+nav_order: 985
 ---
-# v0.1.0
+# 0.1.0
 
 Version 0.1.0 brings these new features:
 
 * **[Quick-open bundle](#quick-open-bundle)** - Quickly jump to a bundle by typing its name
 * **[Hide documentation hints](#hide-documentation-hints)** - Hide documentation hovers when editing manifest.json files
 
-Additionally, find all fixed issues in the [changelog](/CHANGELOG.md).
+Additionally, find all fixed issues in the [changelog](CHANGELOG.html).
 
 ## Quick-open bundle
 

diff --git a/docs/updates/v0.2.0.md b/docs/updates/v0.2.0.md
@@ -0,0 +1,49 @@
+---
+layout: default
+title: 0.2.0
+parent: Updates
+nav_order: 980
+---
+# 0.2.0
+
+Version 0.2.0 brings some subtle improvements:
+
+* **[Conditional extension startup](#conditional-extension-startup)** - Only start up the extension, if the workspace contains a bundle
+* **[Pretty documentation hovers](#pretty-documentation-hovers)** - manifest.json documentation hovers get more styling
+* **[Other improvements](#other-improvements)** - The even more subtle things...
+
+Additionally, find all fixed issues in the [changelog](CHANGELOG.html).
+
+## Conditional extension startup
+
+Maybe a change that you won't necessarily recognize, but yet pleasant to know:
+The extension is not started every time you open VS Code any more.
+Especially if you just fire up VS Code to edit some files in between you don't want to wait any extra (milli)second for it to show up. 
+Now the extension is only loaded, when your workspace contains any bundles, i.e. manifest.json files.
+
+There is one downside to it:
+If you start a new project and create the very first manifest.json file in your workspace, VS Code won't start the extension for you --
+no service name auto-completion, no documentation hovers etc... :cry: 
+
+...until you saved your initial manifest.json file and restarted VS Code.
+Or you run the new command **apprt-bundles: Activate extension** from the command palette.
+
+## Pretty documentation hovers
+
+Documentation hovers got some polish to become more readable and help get the important information easier.
+
+![Pretty documentation hovers](../images/feature_hover_pretty.png)
+
+Simple things like inline code formatting or just bulleted lists improve the way information is conveyed
+(and yes, you can still switch documentation hovers off completely...)
+
+## Other improvements
+
+With the introduction of webpack the **file size** of the extension decreased to nearly 100kB -- down from ~3MB.
+Ok, some unnecessary image and documentation files were removed also, but yet!
+
+When you open a workspace with bundles you will now get a new indicator in the **status bar** of VS Code.
+It will just tell you that it started indexing all bundles and manifest.json files and when it is ready:
+
+![Statusbar indexing...](../images/feature_statusbar_indexing.png)
+