Skip to content

AutoGPT is the vision of accessible AI for everyone, to use and to build on. Our mission is to provide the tools, so that you can focus on what matters.

docs: repoint generate_block_docs links to canonical agpt.co/docs host (#13679)

Abhimanyu Yadav4c346bed784f
diff --git a/autogpt_platform/backend/load-tests/README.md b/autogpt_platform/backend/load-tests/README.md
index 1a19b02ab6..f4a48bf0aa 100644
--- a/autogpt_platform/backend/load-tests/README.md
+++ b/autogpt_platform/backend/load-tests/README.md
@@ -290,7 +290,7 @@ node generate-tokens.js --count=100 --timeout=60
## 🔗 Related Documentation
- [k6 Documentation](https://k6.io/docs/)
-- [AutoGPT Platform API Documentation](https://docs.agpt.co/)
+- [AutoGPT Platform API Documentation](https://agpt.co/docs)
- [k6 Cloud Dashboard](https://significantgravitas.grafana.net/a/k6-app/)
For questions or issues, please refer to the [AutoGPT Platform issues](https://github.com/Significant-Gravitas/AutoGPT/issues).
diff --git a/autogpt_platform/backend/scripts/generate_block_docs.py b/autogpt_platform/backend/scripts/generate_block_docs.py
index 5afb6a7aec..baefffaa4b 100644
--- a/autogpt_platform/backend/scripts/generate_block_docs.py
+++ b/autogpt_platform/backend/scripts/generate_block_docs.py
@@ -33,6 +33,9 @@ if TYPE_CHECKING:
backend_dir = Path(__file__).parent.parent
sys.path.insert(0, str(backend_dir))
+# Imported after the sys.path insert above so the backend package resolves.
+from backend.util.docs import make_doc_url # noqa: E402
+
logger = logging.getLogger(__name__)
# Default output directory relative to repo root
@@ -515,11 +518,13 @@ def generate_overview_table(blocks: list[BlockDoc], block_dir_prefix: str = "")
lines.append("")
lines.append("Want to create your own custom blocks? Check out our guides:")
lines.append("")
+ # Build public doc URLs via the shared helper so the host/shape can't drift
+ # from the copilot docs tools (see backend/util/docs.py).
lines.append(
- "* [Build your own Blocks](https://docs.agpt.co/platform/new_blocks/) - Step-by-step tutorial with examples"
+ f"* [Build your own Blocks]({make_doc_url('platform/new_blocks.md')}) - Step-by-step tutorial with examples"
)
lines.append(
- "* [Block SDK Guide](https://docs.agpt.co/platform/block-sdk-guide/) - Advanced SDK patterns with OAuth, webhooks, and provider configuration"
+ f"* [Block SDK Guide]({make_doc_url('platform/block-sdk-guide.md')}) - Advanced SDK patterns with OAuth, webhooks, and provider configuration"
)
lines.append("{% endhint %}")
lines.append("")
diff --git a/autogpt_platform/backend/scripts/test_generate_block_docs.py b/autogpt_platform/backend/scripts/test_generate_block_docs.py
index a6d6d34992..b17842a71a 100644
--- a/autogpt_platform/backend/scripts/test_generate_block_docs.py
+++ b/autogpt_platform/backend/scripts/test_generate_block_docs.py
@@ -6,6 +6,7 @@ from scripts.generate_block_docs import (
class_name_to_display_name,
extract_manual_content,
generate_anchor,
+ generate_overview_table,
type_to_readable,
)
@@ -204,5 +205,19 @@ class TestIntegration:
assert len(mapping1[file_path]) == len(mapping2[file_path])
+class TestOverviewGuideLinks:
+ """The overview's 'Creating Your Own Blocks' guide links must point at the
+ live docs host, not the dead docs.agpt.co one (OPEN-3209)."""
+
+ def test_no_dead_docs_host(self):
+ overview = generate_overview_table([])
+ assert "docs.agpt.co" not in overview
+
+ def test_links_use_agpt_docs_host(self):
+ overview = generate_overview_table([])
+ assert "(https://agpt.co/docs/platform/new-blocks)" in overview
+ assert "(https://agpt.co/docs/platform/block-sdk-guide)" in overview
+
+
if __name__ == "__main__":
pytest.main([__file__, "-v"])
diff --git a/docs/content/index.md b/docs/content/index.md
index d22bb2885e..fae4f2e1e7 100644
--- a/docs/content/index.md
+++ b/docs/content/index.md
@@ -82,6 +82,6 @@ This strategy allows us to share previously closed-source components, fostering
## Ready to Get Started?
-- Read the [Getting Started docs](https://docs.agpt.co/platform/getting-started/) to self-host
+- Read the [Getting Started docs](https://agpt.co/docs/platform/getting-started) to self-host
- [Join the waitlist](https://agpt.co/waitlist) for the cloud-hosted beta
- [Contribute](contribute/index.md)
\ No newline at end of file
diff --git a/docs/integrations/README.md b/docs/integrations/README.md
index e8fd3f4397..f2da8a5e2d 100644
--- a/docs/integrations/README.md
+++ b/docs/integrations/README.md
@@ -24,8 +24,8 @@ AutoGPT uses a modular approach with various "blocks" to handle different tasks.
Want to create your own custom blocks? Check out our guides:
-* [Build your own Blocks](https://docs.agpt.co/platform/new_blocks/) - Step-by-step tutorial with examples
-* [Block SDK Guide](https://docs.agpt.co/platform/block-sdk-guide/) - Advanced SDK patterns with OAuth, webhooks, and provider configuration
+* [Build your own Blocks](https://agpt.co/docs/platform/new-blocks) - Step-by-step tutorial with examples
+* [Block SDK Guide](https://agpt.co/docs/platform/block-sdk-guide) - Advanced SDK patterns with OAuth, webhooks, and provider configuration
{% endhint %}
Below is a comprehensive list of all available blocks, categorized by their primary function. Click on any block name to view its detailed documentation.
diff --git a/docs/platform/aimlapi.md b/docs/platform/aimlapi.md
index 785fc50e3a..2ce2c26c2c 100644
--- a/docs/platform/aimlapi.md
+++ b/docs/platform/aimlapi.md
@@ -7,7 +7,7 @@ Follow these steps to connect **AI/ML API** with the **AutoGPT** platform for hi
## ✅ Prerequisites
-1. Make sure you have gone through and completed the [AutoGPT Setup Guide](https://docs.agpt.co/platform/getting-started/), and AutoGPT is running locally at `http://localhost:3000`.
+1. Make sure you have gone through and completed the [AutoGPT Setup Guide](https://agpt.co/docs/platform/getting-started), and AutoGPT is running locally at `http://localhost:3000`.
2. You have an **API key** from [AI/ML API](https://aimlapi.com/app/keys?utm_source=autogpt&utm_medium=github&utm_campaign=integration).
---
@@ -17,7 +17,7 @@ Follow these steps to connect **AI/ML API** with the **AutoGPT** platform for hi
### 1. Start AutoGPT Locally
Follow the official guide:
-[📖 AutoGPT Getting Started Guide](https://docs.agpt.co/platform/getting-started/)
+[📖 AutoGPT Getting Started Guide](https://agpt.co/docs/platform/getting-started)
Make sure AutoGPT is running and accessible at:
[http://localhost:3000](http://localhost:3000)
diff --git a/docs/platform/gemini.md b/docs/platform/gemini.md
index de8ebd4cd3..77b43e0e67 100644
--- a/docs/platform/gemini.md
+++ b/docs/platform/gemini.md
@@ -6,7 +6,7 @@ This guide covers integrating Google Gemini models with AutoGPT using OpenRouter
## Prerequisites
-1. Make sure you have completed the [AutoGPT Setup Guide](https://docs.agpt.co/platform/getting-started/) and have AutoGPT running locally at `http://localhost:3000`.
+1. Make sure you have completed the [AutoGPT Setup Guide](https://agpt.co/docs/platform/getting-started) and have AutoGPT running locally at `http://localhost:3000`.
2. You have an **OpenRouter API key** from [OpenRouter](https://openrouter.ai/keys).
---
@@ -27,7 +27,7 @@ AutoGPT routes all Gemini models through OpenRouter. You need an OpenRouter API
### 1. Start AutoGPT Locally
Follow the official guide:
-[AutoGPT Getting Started Guide](https://docs.agpt.co/platform/getting-started/)
+[AutoGPT Getting Started Guide](https://agpt.co/docs/platform/getting-started)
Ensure AutoGPT is running and accessible at:
[http://localhost:3000](http://localhost:3000)
@@ -158,7 +158,7 @@ Pricing varies by model tier and usage volume.
- [Gemini API Quickstart](https://ai.google.dev/gemini-api/docs/quickstart)
- [Model Capabilities](https://ai.google.dev/gemini-api/docs/models)
- [OpenRouter Documentation](https://openrouter.ai/docs)
-- [AutoGPT Platform Docs](https://docs.agpt.co/platform/)
+- [AutoGPT Platform Docs](https://agpt.co/docs/platform)
---