Skip to content

Conversation

BekahHW
Copy link
Collaborator

@BekahHW BekahHW commented Oct 17, 2025

Description

[ What changed? Feel free to be brief. ] We're still using "blocks" throughout the docs and this can become confusing. This PR redirects current broken links to blocks and updates the terminology.

closes CON-4422

AI Code Review

  • Team members only: AI review runs automatically when PR is opened or marked ready for review
  • Team members can also trigger a review by commenting @continue-review

Checklist

  • I've read the contributing guide
  • The relevant docs, if any, have been updated or created
  • The relevant tests, if any, have been updated or created

Screen recording or screenshot

[ When applicable, please include a short screen recording or screenshot - this makes it much easier for us as contributors to review and understand your changes. See this PR as a good example. ]

Tests

[ What tests were added or updated to ensure the changes work as expected? ]


Summary by cubic

Updated docs to replace “Blocks” with current Hub terms (configs, tools, prompts, rules) and prevent 404s with redirects. Also cleaned up copy in config pages and removed the Blocks group from navigation.

  • Refactors

    • Removed “Blocks” from the sidebar navigation.
    • Rewrote config create/edit pages to use current terms and clearer actions (add via “+”, edit YAML, handle secrets).
    • Fixed grammar and titles (e.g., “How to Remix a Config”) and adjusted Hub introduction wording.
  • Bug Fixes

    • Added redirects from /hub/blocks and all child routes (including bundles) to /hub/introduction to fix broken links.

@BekahHW BekahHW marked this pull request as ready for review October 20, 2025 15:52
@BekahHW BekahHW requested a review from a team as a code owner October 20, 2025 15:52
@BekahHW BekahHW requested review from Patrick-Erichsen and removed request for a team October 20, 2025 15:52
@dosubot dosubot bot added the size:L This PR changes 100-499 lines, ignoring generated files. label Oct 20, 2025
Copy link

github-actions bot commented Oct 20, 2025

✅ Review Complete

This PR looks good overall! The documentation updates are clear and the terminology changes from "blocks" to more specific terms (configs, tools, prompts, rules) will reduce confusion for users. Here are some observations:

✅ What Works Well

  1. Comprehensive redirects: All the old /hub/blocks/* routes are properly redirected to prevent 404s
  2. Consistent terminology: The shift away from "blocks" is applied consistently across files
  3. Improved clarity: The new Hub introduction is much clearer about what configs are and how they work
  4. Better organization: Removing the "Blocks" navigation group simplifies the docs structure

Minor Issues

1. Missing file in redirects (line 403)

The redirect for /hub/workflows/intro should point to /hub/agents/intro, but I don't see the corresponding file update in the diff. Actually, I do see docs/hub/workflows/intro.mdx was renamed to docs/hub/agents/intro.mdx - this is correct.

2. Incomplete sentence in edit-a-config.mdx

File: docs/hub/configs/edit-a-config.mdx (line 8)

-For blocks that require secret values like API keys, you will see a small notification on the block's tile in the sidebar that will indicate if action is needed.
+For tools or models that require secret values like API keys, you will see a small notification on the block's tile that will indicate if action is needed.

The text still says "block's tile" but should probably say "component's tile" or "tool's tile" to be consistent with the new terminology.

3. Typo in intro.mdx

File: docs/hub/introduction.mdx (line 21)

Run background agents that complete tasks automatically in your repositories. [Learn more →](/hub/workflows/intro)

This link points to /hub/workflows/intro but based on the redirect, it should point to /hub/agents/intro to avoid an unnecessary redirect hop.

Summary

The PR successfully modernizes the documentation terminology. The only real concern is ensuring all internal links point directly to their destination rather than relying on redirects (which work but add latency). Otherwise, this is a solid documentation improvement that will help users understand the system better.


Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size:L This PR changes 100-499 lines, ignoring generated files.

Projects

Status: Todo

Development

Successfully merging this pull request may close these issues.

1 participant