Skip to content
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

View Component section added, wrapper docs #29

Merged
merged 2 commits into from
Feb 1, 2024

Conversation

CrookedGrin
Copy link

Adding documentation section for View Components in general, and the new wrapping stuff in particular.

Note: this shouldn't be merged until the relevant PRs have gone through in teamshares-rails and design-system. May be subject to change as those get reviewed.

Copy link

vercel bot commented Jan 25, 2024

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

Name Status Preview Comments Updated (UTC)
shoelace ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 31, 2024 11:39pm

@slhinyc
Copy link

slhinyc commented Jan 29, 2024

@CrookedGrin — I think what you have looks good, but also thought about an alternate presentation that separates out the TS-specific guides like this (see SS):

Got the idea from how the main Shoelace site has a "Tutorials" section at the bottom. This way you can see the page titles in the nav & don't have to click in to "Recipe book" to see what recipes are there, and we could potentially add other top-level pages like "Shoelace & Tailwind CSS" (to explain how we're still using Tailwind even with SL).

If we have a lot of "recipes" in the future, we could also move the section further down on the nav, but at least for now I was thinking it'd be nice to be able to just see the recipe page names in the nav. For the VC stuff -- unless we're going to have a ton there, we could just keep it all on one page? A lot of the other doc site pages are also long, but I think with the secondary nav on the right-hand side of the page, it's still easy enough to navigate the pages themselves. I don't feel super strongly either way, but just wanted to propose as an option!

Screenshot 2024-01-29 at 14 42 54

Copy link

@slhinyc slhinyc left a comment

Choose a reason for hiding this comment

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

Added a comment with an alternate proposal for organizing the pages, but this approach looks good to me, too

@CrookedGrin
Copy link
Author

Added a comment with an alternate proposal for organizing the pages, but this approach looks good to me, too

I like your proposal. I'm going to leave the folder structure in place here, because I think it's likely we'll need docs pages for individual view components as we add more of them, but I'll structure the sidebar like you suggest. Thanks!

@CrookedGrin CrookedGrin merged commit 3003fc7 into next Feb 1, 2024
4 checks passed
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.

2 participants