Skip to content

Redesign the site and docs for TallCraftUI 3 - #2

Open
developermithu wants to merge 1 commit into
3.xfrom
redesign-site
Open

developermithu wants to merge 1 commit into
3.xfrom
redesign-site

Conversation

@developermithu

Copy link
Copy Markdown
Owner

Redesigns tallcraftui.com for TallCraftUI 3: the homepage is now a short product page, and the docs are a three-column site generated from one registry. Built with TallCraftUI components wherever practical.

Homepage

  • Hero with a live dashboard built from TallCraftUI. A Preview/Blade toggle shows the exact file it renders from.
  • Showcase tabs (form, data table, settings, sign in, dialogs and toasts), all wired to Livewire on the page: validation errors, server-side table search, modal, drawer and toasts.
  • Syntax demo (code next to its live result), Breeze/Jetstream vs TallCraftUI comparison, component overview, install steps, open source section with live GitHub stars, and a closing call to action.

Docs

  • config/docs.php drives the sidebar, search index, breadcrumbs, previous/next, related components, the /docs landing page and the homepage component grid (App\Support\Docs).
  • Components are grouped into Forms, Elements, Navigation, Overlays, Feedback and Data display. All URLs are unchanged.
  • "On this page" is generated from each page's headings, with scrollspy and a collapsible version on mobile. The hand-written TOCs are removed.
  • Every component page gets an API reference read from the package's component classes: props, types, defaults, colors, sizes, radius and config defaults.
  • Code blocks show the preview above the code, with a language/filename label, copy button, collapse for long snippets and tabbed groups.
  • Cmd/Ctrl+K or / opens a keyboard-navigable search palette over /search-index.json. This replaces Algolia DocSearch.
  • New pages: docs introduction (/docs), Theming, Changelog (every release from v0.9 to v3.0.0-beta.1, from the GitHub releases) and Theme toggle (the component shipped in v2.0.5 but had no page).
  • Rewritten for 3.x: Installation (it still listed Laravel 10–12 and Livewire 3), Configuration (now shows the real config file from the installed package), Upgrade guide (2.x → 3.0 from the package's UPGRADE.md, with 1.x → 2.0 kept) and Contributing.

Design, SEO and fixes

  • Instrument Sans and JetBrains Mono, Tailwind gray neutrals to match the library's dark mode, and a teal accent. Includes dark mode, a mobile drawer nav built on <x-drawer>, and <x-theme-toggle> in the header.
  • Canonical, Open Graph and JSON-LD URLs always use https://tallcraftui.com, set by docs.site_url and overridable with DOCS_SITE_URL. Also adds a new OG image, consistent page titles, the five missing pages in the sitemap and an absolute sitemap URL in robots.txt.
  • Doc bugs fixed: capitalized Indigo (7 pages) and misspelled fuschsia rendered the wrong colors, the button page showed an unsupported 2xl size, the select example used dead Twitter avatar URLs, and the dropdown page had a mislabelled heading.
  • Docs repo links now point to developermithu/tallcraftui.com.

Testing

  • All docs routes, / and /search-index.json return 200.
  • Checked in Playwright at 1440, 1024, 768 and 390px, in light and dark mode. No horizontal overflow.
  • Tested by hand: form validation, table search, modal, drawer and toasts on the homepage; search palette with arrow keys, Enter and section anchors; copy button (the copied code is de-indented); wire:navigate between pages; skip link and focus rings; mobile nav and mobile TOC.

Before merging

  • public/build isn't rebuilt. Run bun run build, because the CSS and JS changed.
  • The @docsearch/css dependency is now unused. I left it in package.json so bun.lockb stays untouched.
  • routes/web.php still exposes public GET /fresh, which runs migrate:fresh --seed --force. Anyone can wipe the production database with it. /clear, /optimize and /storage-link are public too. This PR doesn't change them, but they should be removed or protected.
  • The version switcher's 2.x entry links to the GitHub 2.x branch, and the 1.x link still points to v1-tallcraftui.developermithu.com. Update config/docs.php if those docs live elsewhere.

🤖 Generated with Claude Code

Rebuild the homepage as a product page and the docs as a three-column
documentation site, driven by a single registry in config/docs.php.

- Homepage: hero with a live dashboard that flips to its Blade source,
  interactive showcase (form, table, settings, sign in, dialogs and
  toasts), syntax demo, boilerplate comparison, component overview,
  install steps and open source section
- Docs: generated sidebar, breadcrumbs, previous/next, related
  components, automatic "On this page" with scrollspy, Cmd/Ctrl+K
  search palette over /search-index.json (replaces Algolia DocSearch)
- API reference on every component page, read from the package's
  component classes
- New code blocks: preview over code, language label, copy button,
  collapsible long snippets, tabbed code groups
- New pages: docs introduction, Theming, Changelog, Theme toggle
- Rewritten for 3.x: Installation, Configuration, Upgrade guide,
  Contributing
- Design system: Instrument Sans and JetBrains Mono, gray neutrals,
  teal accent, dark mode, mobile drawer nav and mobile TOC
- SEO: canonical and Open Graph URLs pinned to tallcraftui.com,
  JSON-LD, new OG image, consistent titles, sitemap additions
- Fix doc bugs: capitalized Indigo and misspelled fuchsia attributes,
  unsupported 2xl button size, broken avatar URLs
- Point docs repo links to developermithu/tallcraftui.com

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
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.

1 participant