-
Notifications
You must be signed in to change notification settings - Fork 32
docs: Reorganize navigation structure and improve content #590
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
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>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
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:
/tools/
subdirectory for tool-related docsmcp-servers.mdx
→tools/mcp-servers.mdx
function-tools.mdx
→tools/function-tools.mdx
credentials.mdx
→tools/credentials.mdx
/structured-outputs/
subdirectory for output-related docsdata-components.mdx
→structured-outputs/data-components.mdx
artifact-components.mdx
→structured-outputs/artifact-components.mdx
status-updates.mdx
→structured-outputs/status-updates.mdx
Visual Builder:
/tools/
and/structured-outputs/
subdirectoriesSelf-Hosting:
/add-other-services/
subdirectoryadd-sentry.mdx
→add-other-services/sentry.mdx
add-datadog-apm.mdx
→add-other-services/datadog-apm.mdx
✨ Content Improvements
Vercel AI Elements Integration:
README.md Refresh:
Overview Page:
Community Pages:
/community/inkeep-community.mdx
with cards for all social channelsConcepts Page:
🔄 Backwards Compatibility
redirects.json
to ensure old URLs continue to work🎨 Other Updates
navigation.ts
to reflect new structureTesting
Impact
This reorganization makes it easier for users to: