diff --git a/.gitignore b/.gitignore index eba74f4..18da50b 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,2 @@ -venv/ \ No newline at end of file +venv/ +.venv/ \ No newline at end of file diff --git a/README.md b/README.md index 8c52823..c11b3a0 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,4 @@ -# document-template -Template for Read the Docs + mkdocs +# Workspace Building Block + +> [!NOTE] +> Status: initialized docs from template \ No newline at end of file diff --git a/docs/index.md b/docs/index.md index 352ccc4..8187a8d 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,6 +1,6 @@ # Introduction -The documentation for the `` building block is organised as follows... +The documentation for the `Workspace` building block is organised as follows... * **Introduction**
Introduction to the BB - including summary of purpose and capabilities. @@ -15,7 +15,7 @@ The documentation for the `` building block is organised as follows... * **API**
Details of APIs provided by the BB - including endpoints, usage descriptions and examples etc. -## About `` +## About `Workspace` Description of the purpose of the BB. diff --git a/mkdocs.yml b/mkdocs.yml index e2de2ef..aeaf00c 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,6 +1,6 @@ -site_name: EOEPCA Document Template +site_name: EOEPCA Workspace site_url: https://eoepca.readthedocs.io/projects/template/en/latest/ -repo_url: https://github.com/EOEPCA/document-template/ +repo_url: https://github.com/EOEPCA/workspace/ edit_uri: "edit/main/docs/" nav: