Conversation
We're not in a situation where we need to escape ERB tags, so remove the unnecessary double percent signs.
I'd prefer to have these hosted locally, but for now linking to RubyDoc is fine. Perhaps if I figure out how to serve YARD-generated docs from within the demo apps public/ directory, we can link locally instead.
Allowing users to navigate up and down the class hierarchy.
Having a link that goes to the external Ruby API site right next to one that goes to the internal docs site is confusing
This includes all components that are direct children in the Flowbite module and inherit from ViewComponent::Base.
There was a problem hiding this comment.
Pull request overview
This PR improves documentation and layout across the demo application. The changes focus on fixing ERB template syntax in markdown files, restructuring view layouts for better organization, and adding helper methods to support the new documentation views.
Changes:
- Fixed ERB escaping in documentation markdown files (changed
<%%=to<%=for proper rendering) - Restructured layout with article wrappers moved from layout to individual pages
- Added navigation sidebars to documentation pages with consistent styling
- Enhanced component documentation view with inheritance information, slots table, and structured sections
Reviewed changes
Copilot reviewed 9 out of 10 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| demo/content/pages/overview.md | Fixed ERB escaping for proper code example rendering |
| demo/content/pages/customization_options.md | Fixed ERB escaping for proper code example rendering |
| demo/app/views/layouts/application.html.erb | Removed article wrapper, simplified main container structure |
| demo/app/views/homepage/show.html.erb | Added article wrapper with improved spacing and structure |
| demo/app/views/docs/pages/show.html.erb | Added navigation sidebar with page list |
| demo/app/views/docs/components/show.html.erb | Complete restructure with sidebar navigation, inheritance info, and improved documentation sections |
| demo/app/controllers/docs/components_controller.rb | Added helper methods for component listing and RubyDoc URL generation |
| app/components/flowbite/breadcrumb.rb | Added clarifying sentence to documentation |
| demo/.yardoc/* | Generated documentation files (binary) |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| > | ||
| <%= link_to("https://github.com/substancelab/flowbite-components?tab=readme-ov-file#installation", class: Flowbite::Button.classes(size: :lg) + ["inline-flex", "justify-center", "items-center"]) do %> | ||
| Get started | ||
| <article class="mt-25"> |
There was a problem hiding this comment.
The CSS class "mt-25" is non-standard. Tailwind CSS uses a spacing scale where the standard classes are like "mt-24" (96px) or "mt-28" (112px). The class "mt-25" would need to be defined in the Tailwind configuration or it will have no effect. Consider using a standard Tailwind spacing value like "mt-24" or "mt-28".
| <article class="mt-25"> | |
| <article class="mt-24"> |
There was a problem hiding this comment.
It very much has an effect...
While ensure there's always some whitespace around the content and sidebar
No description provided.