Validate env Hub deployment (#655)

* fix: validate env hub deployment

* docs: improve docs structure

Author: burtenshaw

docs/source/concepts.md

@@ -97,23 +97,18 @@
         "text": "OpenEnv",
     },
     "icon_links": [
-        {
-            "name": "X",
-            "url": "https://x.com/PyTorch",
-            "icon": "fa-brands fa-x-twitter",
-        },
         {
             "name": "GitHub",
             "url": "https://github.com/meta-pytorch/OpenEnv",
             "icon": "fa-brands fa-github",
         },
-        {
-            "name": "Discourse",
-            "url": "https://dev-discuss.pytorch.org/",
-            "icon": "fa-brands fa-discourse",
-        },
     ],
-    "use_edit_page_button": True,
+    "use_edit_page_button": False,
+    "secondary_sidebar_items": ["page-toc"],
+    "article_header_end": [],
+    "article_footer_items": [],
+    "show_lf_footer": False,
+    "show_pytorch_org_link": False,
     "switcher": {
         "json_url": "_static/versions.json",
         "version_match": switcher_version,
@@ -137,7 +132,7 @@
 
 html_context = {
     "theme_variables": theme_variables,
-    "display_github": True,
+    "display_github": False,
     "github_url": "https://github.com",
     "github_user": "meta-pytorch",
     "github_repo": "OpenEnv",

docs/source/conf.py

@@ -1,3 +1,7 @@
+---
+orphan: true
+---
+
 # Contributing to OpenEnv
 
 We welcome contributions from the community! OpenEnv is an open-source project and we're excited to have you join us.
@@ -66,14 +70,13 @@ ruff check .
 - Add type hints
 - Write tests for new functionality
 
-## Community
+## Coordination
 
-- [Discord](https://discord.gg/YsTYBh6PD9) - Chat with the community
-- [GitHub Discussions](https://github.com/meta-pytorch/OpenEnv/discussions) - Ask questions
+Use the [OpenEnv repository](https://github.com/meta-pytorch/OpenEnv) to file
+issues, discuss substantial changes, and submit pull requests.
 
 ## License
 
 By contributing, you agree that your contributions will be licensed under the same license as the project.
 
 Thank you for contributing! 🙏
-

docs/source/contributing.md

@@ -0,0 +1,121 @@
+# Getting Started
+
+Install OpenEnv, load an environment, and run your first step.
+
+## Install OpenEnv
+
+```bash
+pip install openenv-core
+```
+
+```{note}
+This installs the `openenv` CLI and the `openenv.core` runtime. Environment
+projects can depend on `openenv-core[core]` when they only need the server and
+client libraries.
+```
+
+## Try an Environment
+
+Use `AutoEnv` and `AutoAction` when you want OpenEnv to find the matching client
+and action classes for an installed or discoverable environment.
+
+```python
+from openenv import AutoAction, AutoEnv
+
+env = AutoEnv.from_env("echo")
+EchoAction = AutoAction.from_env("echo")
+
+with env.sync() as client:
+    result = client.reset()
+    print(result.observation.echoed_message)  # "Echo environment ready!"
+
+    result = client.step(EchoAction(message="Hello, OpenEnv!"))
+    print(result.observation.echoed_message)  # "Hello, OpenEnv!"
+```
+
+`AutoEnv.from_env()` accepts the common name forms:
+
+```python
+AutoEnv.from_env("echo")
+AutoEnv.from_env("echo-env")
+AutoEnv.from_env("echo_env")
+```
+
+## Connect to a Running Environment
+
+OpenEnv clients are async by default. Use the async client for production code,
+parallel environment runs, and integrations with async frameworks.
+
+```python
+import asyncio
+
+from echo_env import EchoAction, EchoEnv
+
+
+async def main():
+    async with EchoEnv(base_url="https://openenv-echo-env.hf.space") as client:
+        result = await client.reset()
+        print(result.observation.echoed_message)
+
+        result = await client.step(EchoAction(message="Hello, World!"))
+        print(result.reward)
+
+
+asyncio.run(main())
+```
+
+For scripts and notebooks, use `.sync()`:
+
+```python
+from echo_env import EchoAction, EchoEnv
+
+with EchoEnv(base_url="https://openenv-echo-env.hf.space").sync() as client:
+    result = client.reset()
+    result = client.step(EchoAction(message="Hello, World!"))
+    print(result.observation.echoed_message)
+```
+
+## Use Containers or Local Servers
+
+You can run an environment from a Docker image:
+
+```python
+import asyncio
+
+from echo_env import EchoEnv
+
+
+async def main():
+    client = await EchoEnv.from_docker_image(
+        "registry.hf.space/openenv-echo-env:latest"
+    )
+    async with client:
+        result = await client.reset()
+        print(result.observation)
+
+
+asyncio.run(main())
+```
+
+Or connect to a local server:
+
+```bash
+cd path/to/echo-env
+uv venv
+source .venv/bin/activate
+uv pip install -e .
+uv run server --host 0.0.0.0 --port 8000
+```
+
+```python
+from echo_env import EchoEnv
+
+with EchoEnv(base_url="http://localhost:8000").sync() as client:
+    result = client.reset()
+```
+
+## Next Steps
+
+- [Concepts](guides/concepts.md)
+- [Explore environments](environments.md)
+- [Build your first environment](guides/first-environment.md)