From b463be8b23a27360308beffd664a502780d65e0b Mon Sep 17 00:00:00 2001 From: Alyssa Coghlan Date: Fri, 1 Nov 2024 01:12:52 +1000 Subject: [PATCH] Update docs URLs, add OpenGraph metadata Chrome complained about the `lmstudio-ai` subdomain being too close to the main LMStudio domain name at `lmstudio.ai`. Fixing this prompted several other URL related improvements. --- .github/CONTRIBUTING.md | 2 +- CHANGELOG.rst | 2 +- README.md | 2 +- ...241101_003158_ncoghlan_update_docs_url.rst | 42 +++++++++++++++++++ docs/conf.py | 5 ++- docs/index.rst | 6 +++ pyproject.toml | 4 +- 7 files changed, 57 insertions(+), 6 deletions(-) create mode 100644 changelog.d/20241101_003158_ncoghlan_update_docs_url.rst diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index dd57a69..0160740 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -27,6 +27,6 @@ the team is available through the `#dev-chat` channel within the ## Development Documentation -Our [development documentation](https://lmstudio-ai.github.io/venvstacks/development/) +Our [development documentation](https://venvstacks.lmstudio.ai/development/) contains details on how to get started with contributing to `venvstacks`, and details of our development processes. diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 61f4c6d..522c8f1 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -18,7 +18,7 @@ Unreleased See the fragment files in the `changelog.d directory`_. -.. _changelog.d directory: https://github.com/lmstudio-ai/venvstacks/tree/master/changelog.d +.. _changelog.d directory: https://github.com/lmstudio-ai/venvstacks/tree/main/changelog.d .. scriv-insert-here diff --git a/README.md b/README.md index a11d235..9fd670a 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,7 @@ While the layers are archived and published separately, their dependency locking allowing the application layers to share dependencies installed in the framework layers, and the framework layers to share dependencies installed in the runtime layers. -Refer to the [Project Overview](https://lmstudio-ai.github.io/venvstacks/overview/) for an +Refer to the [Project Overview](https://venvstacks.lmstudio.ai/overview/) for an example of specifying, locking, building, and publishing a set of environment stacks. diff --git a/changelog.d/20241101_003158_ncoghlan_update_docs_url.rst b/changelog.d/20241101_003158_ncoghlan_update_docs_url.rst new file mode 100644 index 0000000..1197ba6 --- /dev/null +++ b/changelog.d/20241101_003158_ncoghlan_update_docs_url.rst @@ -0,0 +1,42 @@ +.. A new scriv changelog fragment. +.. +.. Uncomment the header that is right (remove the leading dots). +.. +.. Removed +.. ------- +.. +.. - A bullet item for the Removed category. +.. +.. Added +.. ----- +.. +.. - A bullet item for the Added category. +.. +Changed +------- + +- Update docs URL to `https://venvstacks.lmstudio.ai`__ + +- Add OpenGraph metadata to docs landing page + +- Resolved several broken links in the documentation + +- Documentation is now marked as being unversioned + (it is published directly from the main branch) + +.. +.. Deprecated +.. ---------- +.. +.. - A bullet item for the Deprecated category. +.. +.. Fixed +.. ----- +.. +.. - A bullet item for the Fixed category. +.. +.. Security +.. -------- +.. +.. - A bullet item for the Security category. +.. diff --git a/docs/conf.py b/docs/conf.py index 106673f..0096dc6 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -9,7 +9,7 @@ project = "venvstacks" copyright = "2024, Element Labs Inc." author = "LM Studio" -release = "0.1" +release = "latest" # Docs are currently unversioned # -- General configuration --------------------------------------------------- @@ -34,6 +34,9 @@ html_theme = "furo" html_static_path = ["_static"] +# Docs are published directly to GitHub pages, consider them to be unversioned +html_title = "venvstacks documentation" + # Disable the generation of the various indexes html_use_modindex = False html_use_index = False diff --git a/docs/index.rst b/docs/index.rst index f7d5021..90d6a55 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -2,6 +2,12 @@ Virtual Environment Stacks ========================== +.. meta:: + :og:title: venvstacks - venvstacks Documentation + :og:type: website + :og:url: https://venvstacks.lmstudio.ai/ + :og:description: Virtual Environment Stacks for Python - venvstacks Documentation + Machine learning and AI libraries for Python are big. Really big. Nobody wants to download and install multiple copies of :pypi:`PyTorch ` or :pypi:`CUDA ` if they can reasonably avoid it. diff --git a/pyproject.toml b/pyproject.toml index 66fa815..84b6802 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -51,9 +51,9 @@ venvstacks = "venvstacks.cli:main" [project.urls] Homepage = "https://github.com/lmstudio-ai/venvstacks" -Documentation = "https://lmstudio-ai.github.io/venvstacks/" +Documentation = "https://venvstacks.lmstudio.ai/" Issues = "https://github.com/lmstudio-ai/venvstacks/issues" -Changelog = "https://lmstudio-ai.github.io/venvstacks/changelog/" +Changelog = "https://venvstacks.lmstudio.ai/changelog/" [build-system] requires = ["pdm-backend"]