Skip to content

Comments

docs: document creating packages with framework bindings#9222

Merged
anthonyshew merged 9 commits intomainfrom
shew-f3f9b
Jan 6, 2025
Merged

docs: document creating packages with framework bindings#9222
anthonyshew merged 9 commits intomainfrom
shew-f3f9b

Conversation

@anthonyshew
Copy link
Contributor

@anthonyshew anthonyshew commented Oct 4, 2024

Description

We've had users ask about how to create bindings in their packages, so documenting it here.

Testing Instructions

👀

@turbo-orchestrator turbo-orchestrator bot added area: docs Improvements or additions to documentation created-by: turborepo labels Oct 4, 2024
@vercel
Copy link
Contributor

vercel bot commented Oct 4, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
examples-basic-web ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 6, 2025 9:52pm
examples-designsystem-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 6, 2025 9:52pm
examples-gatsby-web ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 6, 2025 9:52pm
examples-kitchensink-blog ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 6, 2025 9:52pm
examples-native-web ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 6, 2025 9:52pm
examples-nonmonorepo ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 6, 2025 9:52pm
examples-svelte-web ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 6, 2025 9:52pm
examples-tailwind-web ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 6, 2025 9:52pm
examples-vite-web ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 6, 2025 9:52pm

@github-actions
Copy link
Contributor

github-actions bot commented Oct 4, 2024

Hi there 👋

It looks like this PR introduces broken links to the docs, please take a moment to fix them before merging:

Broken link Type File
/repo/docs/guides/tools/typescript#you-likely-dont-need-a-tsconfigjson-file-in-the-root-of-your-project hash /repo-docs/crafting-your-repository/structuring-a-repository.mdx
#package-entrypoint-wildcards hash /repo-docs/guides/tools/typescript.mdx
#package-entrypoint-wildcards hash /repo-docs/guides/tools/typescript.mdx

Thank you 🙏

@anthonyshew anthonyshew changed the title (docs): Document creating packages with Next.js bindings. (docs): Document creating packages with framework bindings. Nov 5, 2024
@turbo-orchestrator turbo-orchestrator bot added the area: site Issues and improvements related to Turborepo's documentation website label Jan 2, 2025
@anthonyshew anthonyshew marked this pull request as ready for review January 2, 2025 04:45
@anthonyshew anthonyshew requested a review from a team as a code owner January 2, 2025 04:45
Copy link
Member

@tknickman tknickman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A few suggestions, but nothing blocking!

Comment on lines +61 to +62
- `./link`: An `<a>` HTML tag with some default styles from your design system
- `./next-js/link`: A customized version of [the Next.js `Link` component](https://nextjs.org/docs/app/building-your-application/routing/linking-and-navigating#link-component) with props that are preset to your organization's preferences
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This would sink in more for me if we added another framework:

- `./link`: ...
- `./next-js/link`: ...
- `./svelte/link`: ...

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

Labels

area: docs Improvements or additions to documentation area: site Issues and improvements related to Turborepo's documentation website

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants