+
Skip to content

Conversation

nick-inkeep
Copy link
Collaborator

Overview

This PR reorganizes the documentation navigation structure for better clarity and adds several content improvements including integration of Vercel AI Elements documentation.

Key Changes

📁 Navigation Reorganization

Restructured documentation to create clearer topic groupings:

TypeScript SDK:

  • Created /tools/ subdirectory for tool-related docs
    • mcp-servers.mdxtools/mcp-servers.mdx
    • function-tools.mdxtools/function-tools.mdx
    • credentials.mdxtools/credentials.mdx
  • Created /structured-outputs/ subdirectory for output-related docs
    • data-components.mdxstructured-outputs/data-components.mdx
    • artifact-components.mdxstructured-outputs/artifact-components.mdx
    • status-updates.mdxstructured-outputs/status-updates.mdx

Visual Builder:

  • Applied same structure with /tools/ and /structured-outputs/ subdirectories
  • Maintains consistency with TypeScript SDK organization

Self-Hosting:

  • Created /add-other-services/ subdirectory
    • add-sentry.mdxadd-other-services/sentry.mdx
    • add-datadog-apm.mdxadd-other-services/datadog-apm.mdx

✨ Content Improvements

Vercel AI Elements Integration:

  • Added comprehensive documentation about Vercel AI Elements
  • Added early callout in Overview section introducing AI Elements as an option
  • Added "Using AI Elements" section with practical code example
  • Added AI Elements card to Next Steps for discoverability
  • Clarified two paths: AI Elements (prebuilt) vs custom implementation with useChat

README.md Refresh:

  • Improved positioning and use case descriptions
  • Better explanation of No-Code Visual Builder vs TypeScript SDK
  • Clearer platform overview section
  • Updated license and community sections

Overview Page:

  • Clearer positioning as "Build AI Agents and Agentic Workflows"
  • Better use case examples
  • Improved "Two ways to build" section
  • Added "Our Approach" section emphasizing extensibility

Community Pages:

  • Expanded /community/inkeep-community.mdx with cards for all social channels
  • Added X (Twitter), GitHub, YouTube, LinkedIn links
  • Better call-to-action for engagement

Concepts Page:

  • Updated all internal links to reflect new navigation structure
  • Improved descriptions and organization

🔄 Backwards Compatibility

  • Added 90+ redirects in redirects.json to ensure old URLs continue to work
  • All existing external links will redirect to new locations automatically

🎨 Other Updates

  • Updated titles and sidebar titles for better clarity
  • Improved SEO metadata and descriptions throughout
  • Updated navigation.ts to reflect new structure
  • Minor content polish in troubleshooting and other pages
  • Updated JSON-LD structured data for better SEO

Testing

  • ✅ All redirects tested and working
  • ✅ Navigation structure renders correctly
  • ✅ Code examples validated
  • ✅ Internal links updated and verified
  • ✅ Build passes locally

Impact

This reorganization makes it easier for users to:

  1. Find tool-related documentation in one place
  2. Understand structured output options
  3. Navigate between Visual Builder and TypeScript SDK docs
  4. Discover Vercel AI Elements as a quick-start option
  5. Find relevant community resources

nick-inkeep and others added 15 commits October 12, 2025 15:03
Restructure documentation navigation for better discoverability and clarity by grouping related pages into organized folders.

## Changes

### Structured Outputs
- Group data-components, artifact-components, and status-updates/status-components into `structured-outputs/` folders
- Update icon for Data Components from LuLayoutTemplate to LuBlocks for better differentiation

### Tools
- Group MCP servers, function-tools, and credentials into `tools/` folders
- Rename `tools-and-mcp-servers.mdx` to `mcp-servers.mdx` for consistency
- Update icon for Add Services from LuPlus to LuPackage

### Self-Hosting Services
- Group Sentry and Datadog into `add-other-services/` folder under Self-Hosting
- Rename files from `add-sentry.mdx` to `sentry.mdx` and `add-datadog-apm.mdx` to `datadog-apm.mdx`

## Technical Details
- Added 17 permanent redirects to maintain backward compatibility
- Updated all internal documentation links across 13+ files
- Updated navigation.ts with new grouped structure
- All old files removed, new directories created with proper structure

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
Add WebSite schema structured data to improve how Google displays
the site name in search results.

Changes:
- Add JSON-LD WebSite schema to root layout with site name "Inkeep Agents"
- Include alternateName "Inkeep" as fallback
- Apply XSS protection by escaping < characters
- Simplify page titles from "Page - Inkeep Docs ~ Open Source Agent Builder"
  to "Page - Inkeep Docs" for cleaner branding

This provides stronger signals to Google for displaying "Inkeep Agents"
as the site name in search results for the docs.inkeep.com subdomain.

The implementation follows Google's site-name guidelines and Next.js 15
best practices for JSON-LD structured data.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
Install schema-dts for type-safe schema.org definitions and update
the WebSite schema in layout.tsx to use proper TypeScript types.

Changes:
- Install schema-dts dev dependency
- Import WebSite and WithContext types from schema-dts
- Add type annotation to jsonLd: WithContext<WebSite>
- Rename site from "Inkeep Agents" to "Inkeep Docs"

This provides compile-time type checking for the structured data
and prevents potential errors in the schema definition.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
- Regenerated pnpm-lock.yaml to fix patchedDependencies mismatch
- Removes overly restrictive CPU constraint from libsql package
- Resolves ERR_PNPM_LOCKFILE_CONFIG_MISMATCH error on Vercel
- Pin fumadocs-openapi to 9.4.0 to prevent version conflicts
- Add custom not-found.tsx and error.tsx to avoid fumadocs-ui compatibility issues
- Update pnpm-lock.yaml to resolve ERR_PNPM_LOCKFILE_CONFIG_MISMATCH

These changes ensure consistent builds across local and CI/CD environments.
- Rename Error to ErrorPage to avoid shadowing global
- Add type="button" to button element
- Set NODE_ENV=production in agents-docs build script
- Resolves 'Html should not be imported outside pages/_document' error
- Ensures consistent builds regardless of local NODE_ENV setting
- Apply same NODE_ENV=production fix to agents-manage-ui
- Resolves Html import error in agents-manage-ui build
- Remove custom error pages (not-found.tsx, error.tsx) - not needed with NODE_ENV=production
- Revert fumadocs-openapi to ^9.4.0 (unpinned) - pinning was unnecessary
- Update pnpm-lock.yaml to reflect changes

The actual fix for Vercel deployment was only:
1. Regenerating pnpm-lock.yaml to fix patch hash mismatch
2. Setting NODE_ENV=production in build scripts
Add permanent redirect from /typescript-sdk/request-context to
/typescript-sdk/headers for backward compatibility.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
The lockfile was previously generated with pnpm 9.8.0, which uses base32
hash format (4o4xvnq62nkojrm2vwqdgdti6i), but CI uses pnpm 10.10.0 which
expects SHA256 format (57c6f1f9835fc6413b1565f909243d713314fac7b3e5fc8ccb3963a4c8b8d9a1).

This was causing ERR_PNPM_LOCKFILE_CONFIG_MISMATCH errors in CI for
agents-manage-api, agents-manage-ui, and agents-run-api builds.

Changes:
- Switched local pnpm version to 10.10.0 to match project specification
- Regenerated pnpm-lock.yaml with correct hash format
- Added fast-glob and updated next-validate-link in agents-docs

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
Copy link

changeset-bot bot commented Oct 13, 2025

⚠️ No Changeset found

Latest commit: 2148083

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link

vercel bot commented Oct 13, 2025

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Preview Comments Updated (UTC)
agents-docs Ready Ready Preview Comment Oct 13, 2025 4:29pm
agents-manage-api Ready Ready Preview Comment Oct 13, 2025 4:29pm
agents-manage-ui Ready Ready Preview Comment Oct 13, 2025 4:29pm
agents-run-api Ready Ready Preview Comment Oct 13, 2025 4:29pm

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant

点击 这是indexloc提供的php浏览器服务,不要输入任何密码和下载