docs: Rename config terminology to workspace

Author: tony

docs/about.md

@@ -9,18 +9,18 @@
 tmuxp helps you manage tmux workspaces.
 
 Built on a object relational mapper for tmux. tmux users can reload common
-workspaces from YAML, JSON and {py:obj}`dict` configurations like
-[tmuxinator][tmuxinator] and [teamocil][teamocil].
+workspaces from YAML, JSON and {py:obj}`dict` workspace files like
+[tmuxinator] and [teamocil].
 
 tmuxp is used by developers for tmux automation at great companies like
-[Bugsnag][bugsnag], [Pragmatic Coders][pragmatic coders] and many others.
+[Bugsnag], [Pragmatic Coders] and many others.
 
 To jump right in, see {ref}`quickstart` and {ref}`examples`.
 
 Interested in some kung-fu or joining the effort? {ref}`api` and
 {ref}`developing`.
 
-[MIT-licensed][mit-licensed]. Code on [github](http://github.com/tmux-python/tmuxp).
+[MIT-licensed]. Code on [github](http://github.com/tmux-python/tmuxp).
 
 [bugsnag]: https://blog.bugsnag.com/benefits-of-using-tmux/
 [pragmatic coders]: http://pragmaticcoders.com/blog/tmuxp-preconfigured-sessions/
@@ -64,7 +64,7 @@ format [^id4]. See {ref}`cli-freeze`.
 
 **JSON config** JSON config support. See {ref}`Examples`.
 
-**ORM-based API** via [libtmux][libtmux] - Utilitizes tmux >= 1.8's unique ID's for
+**ORM-based API** via [libtmux] - Utilitizes tmux >= 1.8's unique ID's for
 panes, windows and sessions to create an object relational view of the tmux
 {class}`~libtmux.Server`, its {class}`~libtmux.Session`,
 {class}`~libtmux.Window`, and {class}`~libtmux.Pane`.

docs/about_tmux.md

@@ -456,7 +456,7 @@ Tmux windows can be split into multiple panes.
 
 ## Configuring tmux
 
-Tmux can be configured via a configuration at `~/.tmux.conf`.
+Tmux can be configured via a `tmux(1)` configuration at `~/.tmux.conf`.
 
 Depending on your tmux version, there is different options available.
 

docs/configuration/examples.md

@@ -4,7 +4,7 @@
 
 ## Short hand / inline style
 
-tmuxp has a short-hand syntax to for those who wish to keep their configs
+tmuxp has a short-hand syntax to for those who wish to keep their workspace
 punctual.
 
 ::::{sidebar} short hand
@@ -636,7 +636,7 @@ this example):
 ```yaml
 session_name: my session
 before_script: ./bootstrap.py
-# ... the rest of your config
+# ... the rest of your workspace
 
 ```
 ````
@@ -659,7 +659,7 @@ and panes omitted in this example)
 ```yaml
 session_name: another example
 before_script: /absolute/path/this.sh # abs path to shell script
-# ... the rest of your config
+# ... the rest of your workspace
 
 ```
 ````
@@ -677,21 +677,21 @@ before_script: /absolute/path/this.sh # abs path to shell script
 
 [exit status]: http://tldp.org/LDP/abs/html/exit-status.html
 
-## Per-project tmux config
+## Per-project tmuxp workspaces
 
 You can load your software project in tmux by placing a `.tmuxp.yaml` or
-`.tmuxp.json` in the project's config and loading it.
+`.tmuxp.json` in the project's workspace and loading it.
 
-tmuxp supports loading configs via absolute filename with `tmuxp load`
-and via `$ tmuxp load .` if config is in directory.
+tmuxp supports loading workspace via absolute filename with `tmuxp load`
+and via `$ tmuxp load .` if workspace is in the directory.
 
 ```console
 
 $ tmuxp load ~/workspaces/myproject.yaml
 
 ```
 
-See examples of `tmuxp` in the wild. Have a project config to show off?
+See examples of `tmuxp` in the wild. Have a project workspace to show off?
 Edit this page.
 
 - <https://github.com/tony/dockerfiles/blob/master/.tmuxp.yaml>

docs/configuration/index.md

@@ -2,11 +2,13 @@
 
 (configuration)=
 
-# Configuration
+(workspace)=
+
+# Workspace files
 
 tmuxp loads your terminal workspace into tmux using workspace files.
 
-The configuration file can be JSON or YAML. It's declarative style resembles tmux's object hierarchy: session, window and wanes.
+The workspace file can be JSON or YAML. It's declarative style resembles tmux's object hierarchy: session, window and wanes.
 
 ## Launching your session
 
@@ -19,7 +21,7 @@ $ tmuxp load ./path/to/file
 tmuxp will offers to assist when:
 
 - _Session already exists_: tmuxp will prompt you to re-attach. It does this
-  by checking if the configuration's `session_name` matches a session already
+  by checking if the workspace's `session_name` matches a session already
   running on the same server.
 - _When inside a tmux client_, `tmuxp` will let you create a new session and switch to it, or append the windows to your existing
   session.
@@ -57,7 +59,7 @@ As of 1.11.x.
 
 ````
 
-Breaking down the basic configuration into sections:
+Breaking down the basic workspace into sections:
 
 1. A session name
 
@@ -102,7 +104,7 @@ Breaking down the basic configuration into sections:
 
 ### Direct
 
-You can create a configuration and load it from anywhere in your file system.
+You can create a workspace and load it from anywhere in your file system.
 
 ```console
 $ tmuxp load [workspace-file]
@@ -120,7 +122,7 @@ $ tmuxp load /opt/myapp/favorites.yaml
 ```
 ````
 
-### User-based configurations
+### User-based workspaces
 
 tmuxp uses the [XDG Base Directory] specification.
 
@@ -143,12 +145,12 @@ This path can be overridden by {ref}`TMUXP_CONFIGDIR`
 
 ### Project-specific
 
-You can store a configuration in your project's root directory as `.tmuxp.yaml` or `.tmuxp.json`, then:
+You can store a workspace in your project's root directory as `.tmuxp.yaml` or `.tmuxp.json`, then:
 
 Assume `.tmuxp.yaml` inside `/opt/myapp`
 
 ```console
-$ tmuxp load [config_path]
+$ tmuxp load [workspace-file]
 ```
 
 ````{tab} In project root

docs/glossary.md

@@ -14,7 +14,9 @@ tmux(1)
     layer on top of tmux.
 
 ConfigReader
-    configuration management class.
+    configuration management class, for parsing YAML / JSON / etc. files
+    to and from python data (dictionaries, in the future, potentially
+    dataclasses)
 
 Server
     Tmux runs in the background of your system as a process.

docs/plugins/index.md

@@ -8,9 +8,9 @@ tmuxp without the need to change tmuxp itself.
 ## Using a Plugin
 
 To use a plugin, install it in your local python environment and add it to
-your tmuxp configuration file.
+your tmuxp workspace file.
 
-### Example Configurations
+### Example Workspace files
 
 ````{tab} YAML
 

docs/quickstart.md

@@ -73,10 +73,10 @@ via trunk (can break easily):
 
 tmuxp launches workspaces / sessions from JSON and YAML files.
 
-Configuration files can be stored in `$HOME/.tmuxp` or in project
+Workspace files can be stored in `$HOME/.tmuxp` or in project
 directories as `.tmuxp.py`, `.tmuxp.json` or `.tmuxp.yaml`.
 
-Every configuration is required to have:
+Every workspace file is required to have:
 
 1. `session_name`
 2. list of `windows`
@@ -106,7 +106,7 @@ $ tmuxp load example.yaml anothersession.yaml
 ```
 
 tmuxp will offer to `switch-client` for you if you're already in a
-session. You can also load a configuration, and append the windows to
+session. You can also load a workspace and append the windows to
 the current active session.
 
 You can also have a custom tmuxp config directory by setting the

src/tmuxp/exc.py

@@ -14,12 +14,12 @@ class TmuxpException(Exception):
 
 class WorkspaceError(TmuxpException):
 
-    """Error parsing tmuxp configuration dict."""
+    """Error parsing tmuxp workspace data."""
 
 
 class EmptyWorkspaceException(WorkspaceError):
 
-    """Configuration is empty."""
+    """Workspace file is empty."""
 
 
 class TmuxpPluginException(TmuxpException):

src/tmuxp/plugin.py

@@ -189,17 +189,17 @@ def before_script(self, session):
 
         This runs after the workspace has been loaded with ``tmuxp load``. It
         augments instead of replaces the ``before_script`` section of the
-        configuration.
+        workspace data.
 
         This hook provides access to the LibTmux.session object for any
         behavior that would be used in the ``before_script`` section of the
-        configuration file that needs access directly to the session object.
+        workspace file that needs access directly to the session object.
         This runs after the workspace has been loaded with ``tmuxp load``.
 
         The hook augments, rather than replaces, the ``before_script`` section
-        of the configuration. While it is possible to do all of the
-        ``before_script`` configuration in this function, if a shell script
-        is currently being used for the configuration, it would be cleaner to
+        of the workspace. While it is possible to do all of the
+        ``before_script`` workspace in this function, if a shell script
+        is currently being used for the workspace, it would be cleaner to
         continue using the script in the ``before_section``.
 
         If changes to the session need to be made prior to

src/tmuxp/workspace/builder.py

@@ -1,4 +1,4 @@
-"""Create a tmux workspace from a workspace configuration :py:obj:`dict`.
+"""Create a tmux workspace from a workspace :py:obj:`dict`.
 
 tmuxp.workspace.builder
 ~~~~~~~~~~~~~~~~~~~~~~~