Skip to content

docs(readme): link each package to its docs guide#61

Merged
suleimansh merged 1 commit into
mainfrom
docs/readme-link-package-guides
Jun 27, 2026
Merged

docs(readme): link each package to its docs guide#61
suleimansh merged 1 commit into
mainfrom
docs/readme-link-package-guides

Conversation

@suleimansh

Copy link
Copy Markdown
Member

Now that the docs site has a deep guide page per package, surface them from the root README.

What

  • Added a Docs column to the package table, linking each row to its guide:
    • ai-sdk -> docs/packages/ai-sdk/index.md
    • ai-skills / ai-autopilot / ai-mcp / mcp -> their docs/packages/*.md pages
  • Added a one-line documentation pointer above the table (the guide + the getting-started walkthrough).

Links are relative to the docs/ sources, so they render on GitHub today. They get repointed to the hosted site once it is live (same interim approach as the rudder docs re-point).

Docs-only, no changeset.

Now that the docs site has a guide page per package, add a Docs column to the
root README package table linking each row to its guide, plus a short
documentation pointer above the table (guide + getting-started walkthrough).

Links are relative to the docs/ sources so they render on GitHub today; they
get repointed to the hosted site once it is live.
@suleimansh suleimansh added the documentation Improvements or additions to documentation label Jun 27, 2026
@suleimansh suleimansh self-assigned this Jun 27, 2026
@suleimansh suleimansh merged commit 67549f5 into main Jun 27, 2026
1 check passed
@suleimansh suleimansh deleted the docs/readme-link-package-guides branch June 27, 2026 19:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant