Skip to content

Conversation

A-wakil
Copy link
Contributor

@A-wakil A-wakil commented Jul 21, 2025

Purpose of this pull request

The current documentation for the dropin-template repo does not have a detailed explanation on how to get started with the Sandbox to preview built dropins. This PR adds fully detailed instructions to get started with the dropin-template sandbox.

Associated JIRA ticket

Jira ticket

Affected pages

  • src/content/docs/dropins/all/creating.mdx

@bdenham bdenham self-requested a review July 21, 2025 16:12
@bdenham bdenham added the documentation Improvements or additions to documentation label Jul 21, 2025
@bdenham bdenham marked this pull request as draft July 21, 2025 16:13
@jeff-matthews jeff-matthews added the major-update Significant original updates to existing content label Jul 22, 2025
@bdenham bdenham marked this pull request as ready for review July 22, 2025 19:08
@bdenham
Copy link
Collaborator

bdenham commented Jul 24, 2025

I will continue my review and walkthrough tomorrow when I'm back from PTO.

Now we're ready to start building a composable frontend. Stop the server with `ctrl + c` and let's get started.

**Tip:**
Stop the server with `Ctrl + C`.
</Task>

<Task>
### Generate a new UI Component
Copy link
Collaborator

@bdenham bdenham Aug 5, 2025

Choose a reason for hiding this comment

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

This topic needs more details about what a UI Component is in the context of drop-ins and what it's purpose is within the drop-in.

These files were not only generated with the appropriate names, but they are completely preconfigured to work together as a unit. For example, the `LoginForm` component was automatically imported into `src/components/index.ts` to let you start referencing the component throughout your project.

And if you run `npm run dev` again, you'll see your new component in the Storybook UI, configured with an example and best practices to help you get started with Storybook.

</Task>

<Task>
### Generate a new API Function
Copy link
Collaborator

@bdenham bdenham Aug 5, 2025

Choose a reason for hiding this comment

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

This topic needs more details about what the API function is for (provide examples) in the context of a drop-in.


{/* TODO: Add code block of files generated */}

Review the files generated in `src/api/`.
</Task>

<Task>
### Generate a Frontend Container
Copy link
Collaborator

@bdenham bdenham Aug 5, 2025

Choose a reason for hiding this comment

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

This topic needs more details about what a Container is in the context of drop-ins and what it's purpose is within the drop-in.

Copy link
Collaborator

@bdenham bdenham left a comment

Choose a reason for hiding this comment

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

Please provide more details as mentioned in the comments above.

Copy link
Collaborator

@bdenham bdenham left a comment

Choose a reason for hiding this comment

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

Please provide more details as mentioned in the comments above.

@bdenham
Copy link
Collaborator

bdenham commented Aug 8, 2025

Superseded by #405

@bdenham bdenham closed this Aug 8, 2025
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 major-update Significant original updates to existing content
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants