Merge pull request #24 from xyngular/josho/update-doc-links

fix: documentation links.

Readme.md

@@ -136,7 +136,7 @@ For each directory/path, we go through these providers (second):
     - [Provider Chain](#provider-chain)
     - [Supported Providers](#supported-providers)
 
-** TODO In the order they are specified above (see [Standard Lookup Order](#standard-lookup-order)).
+** TODO In the order they are specified above (see [Standard Lookup Order](https://xyngular.github.io/py-xcon/latest/detailed_overview/#standard-lookup-order)).
 
 ### Param Store Provider Specifics
 
@@ -183,7 +183,7 @@ If you want to use a dynamo table cache (see [caching](#caching) in next section
     - [App Permissions](https://github.com/xyngular/py-xcon/blob/main/xcon/serverless_files/config_manager/cache-table.yml)
     - [Table Definition](https://github.com/xyngular/py-xcon/blob/main/xcon/serverless_files/cache-permissions.yml)
 
-***TODO For more details, see [Permissions](#permissions).
+For more details, see [Permissions](https://xyngular.github.io/py-xcon/latest/detailed_overview/#permissions).
 
 
 ## Caching

docs/detailed_overview.md

@@ -17,12 +17,12 @@ title: Detailed Overview
     Thank you for your support while the code base transitions to being open-source!
 
 
-# Overview
+## Overview
 
 xcon's goal as a library is to simplify/abstract configuration lookup for our various
 processors and services.
 
-## Historical Background
+### Historical Background
 
 When we first started trying to get configuration from SSM dynamically,
 we ran into a few issues.
@@ -42,7 +42,7 @@ We decided back then to write up a Config class to solve all these issues.
 We were able to speed up the queries to the services, and cache things to help prevent throttling,
 and cache the results in dynamo to make it even faster and more resilient against throttling.
 
-## Summary
+### Summary
 
 We have a few basic/general concepts in xcon that you should be familiar with
 when working with the library.
@@ -124,7 +124,7 @@ followed by a link to more details.
     - For details see [Caching](#caching)
 
 
-## Service/Environment Names {#service-environment-names}
+### Service/Environment Names {#service-environment-names}
 
 There are two special variables that `xcon.config.Config` treats special:
 
@@ -150,7 +150,7 @@ There are two special variables that `xcon.config.Config` treats special:
 
 ???+ important "For these two ^ special values, [`Config`](../api/xcon/config.html#xcon.config.Config){target=_blank} skips the normal [Provider Chain][provider-chain]."
 
-### Search Order
+#### Search Order
 
 Config will only look in these locations for the special variables
 `Config.SERVICE_NAME` and `Config.APP_ENV`:
@@ -163,7 +163,7 @@ Config will only look in these locations for the special variables
       environmental variables (all other config values would not).
 3. [Defaults] last (including any defaults in the [Parent Chain][parent-chain]).
 
-## Quick Examples
+### Quick Examples
 [quick-start]: #quick-start
 
 Let's start with a very simple example:
@@ -187,7 +187,7 @@ ready-to-use `xcon.config.Config` as a resource (`xinject.dependency.Dependency`
 So you can just import this special `xcon.config.config` variable to easily always
 use current `xcon.config.Config.current` resource.
 
-## Naming Guidelines
+### Naming Guidelines
 
 - `Config.SERVICE_NAME` and `Config.APP_ENV` values should be named with no spaces but using
   `camelCase` to separate any words.
@@ -209,7 +209,7 @@ use current `xcon.config.Config.current` resource.
     - The service name and env name that make up the `xcon.directory.Directory.path`
       is case-sensitive. But the part after that for the config name is **NOT**.
 
-## Standard Lookup Order
+### Standard Lookup Order
 
 By Default, Config will look at the following locations by default
 (see [Provider Chain][provider-chain] for details):
@@ -274,7 +274,7 @@ config.set_default("service_name", "someServiceName")
 
 By default, [overrides] and [defaults] are inherited from the [Parent Chain][parent-chain].
 
-## Exports
+### Exports
 
 ???+ note "This is something we have not really utilized yet"
     Config supports it, but we don't really use this feature anywhere currently.

docs/index.md

@@ -196,7 +196,7 @@ For each directory/path, we go through these providers (second):
     - [Provider Chain](detailed_overview.md#provider-chain)
     - [Supported Providers](detailed_overview.md#supported-providers)
 
-** TODO In the order they are specified above (see [Standard Lookup Order](detailed_overview.md#standard-lookup-order)).
+In the order they are specified above (see [Standard Lookup Order](detailed_overview.md#standard-lookup-order)).
 
 ### Param Store Provider Specifics
 
@@ -243,7 +243,7 @@ If you want to use a dynamo table cache (see [caching](#caching) in next section
     - [App Permissions](https://github.com/xyngular/py-xcon/blob/main/xcon/serverless_files/config_manager/cache-table.yml)
     - [Table Definition](https://github.com/xyngular/py-xcon/blob/main/xcon/serverless_files/cache-permissions.yml)
 
-***TODO For more details, see [Add Permissions](#add-permissions).
+For more details, see [Permissions](detailed_overview.md#permissions).
 
 
 ## Caching