Skip to content

Add Ack documentation site #21

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.

Sign up for GitHub

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

Merged
leoafarias merged 1 commit into from
Jul 15, 2026
Merged

Add Ack documentation site #21

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
60 changes: 59 additions & 1 deletion components/FloatingNavbar.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,12 +22,14 @@ function DiscordIcon(props: React.ComponentPropsWithoutRef<'svg'>) {
)
}

type ProductId = 'mix' | 'remix' | 'stargate' | 'code-analysis'
type ProductId = 'mix' | 'remix' | 'ack' | 'stargate' | 'code-analysis'

function getActiveProduct(pathname: string | null): ProductId {
if (!pathname) return 'mix'
if (pathname.startsWith('/documentation/remix')) return 'remix'
if (pathname === '/remix' || pathname.startsWith('/remix/')) return 'remix'
if (pathname.startsWith('/documentation/ack')) return 'ack'
if (pathname === '/ack' || pathname.startsWith('/ack/')) return 'ack'
if (pathname === '/stargate' || pathname.startsWith('/stargate/')) return 'stargate'
if (pathname === '/code-analysis' || pathname.startsWith('/code-analysis/')) return 'code-analysis'
return 'mix'
Expand All @@ -46,21 +48,25 @@ const VERSION_ITEMS = [

const MIX_GITHUB_URL = 'https://github.com/btwld/mix'
const REMIX_GITHUB_URL = 'https://github.com/btwld/remix'
const ACK_GITHUB_URL = 'https://github.com/btwld/ack'
const TWITTER_URL = 'https://twitter.com/leoafarias'
const DISCORD_URL = 'https://discord.com/invite/Ycn6GV3m2k'
const MIX_DOCS_URL = '/documentation/mix/overview/introduction'
const REMIX_DOCS_URL = '/documentation/remix'
const ACK_DOCS_URL = '/documentation/ack/getting-started/overview'

// Stargate and Code Analysis have no public docs or repos yet.
function getDocsHref(product: ProductId): string | null {
if (product === 'mix') return MIX_DOCS_URL
if (product === 'remix') return REMIX_DOCS_URL
if (product === 'ack') return ACK_DOCS_URL
return null
}

function getGithubHref(product: ProductId): string | null {
if (product === 'mix') return MIX_GITHUB_URL
if (product === 'remix') return REMIX_GITHUB_URL
if (product === 'ack') return ACK_GITHUB_URL
return null
}

Expand Down Expand Up @@ -91,6 +97,13 @@ const PRODUCTS: Product[] = [
href: '/remix',
logo: '/assets/logo_remix_sidebar.png',
},
{
id: 'ack' as const,
label: 'Ack',
href: '/ack',
logo: '/assets/logo_ack_sidebar.svg',
showLabel: true,
},
{
id: 'stargate' as const,
label: 'Stargate',
Expand Down Expand Up @@ -197,6 +210,51 @@ const DOCS_SECTIONS: Partial<Record<ProductId, DocsEntry[]>> = {
],
},
],
ack: [
{
label: 'Getting Started',
pages: [
{ label: 'Overview', href: '/documentation/ack/getting-started/overview' },
{ label: 'Installation', href: '/documentation/ack/getting-started/installation' },
{ label: 'Quickstart Tutorial', href: '/documentation/ack/getting-started/quickstart-tutorial' },
],
},
{
label: 'Essentials',
pages: [
{ label: 'Schema Types', href: '/documentation/ack/essentials/schemas' },
{ label: 'Validation Rules', href: '/documentation/ack/essentials/validation' },
{ label: 'Error Handling', href: '/documentation/ack/essentials/error-handling' },
{ label: 'JSON Serialization', href: '/documentation/ack/essentials/json-serialization' },
],
},
{
label: 'How-To Guides',
pages: [
{ label: 'Flutter Form Validation', href: '/documentation/ack/how-to-guides/flutter-form-validation' },
{ label: 'Common Recipes', href: '/documentation/ack/how-to-guides/common-recipes' },
{ label: 'Custom Validation', href: '/documentation/ack/how-to-guides/custom-validation' },
],
},
{
label: 'Advanced',
pages: [
{ label: 'Codecs', href: '/documentation/ack/advanced/codecs' },
{ label: 'TypeSafe Schemas', href: '/documentation/ack/advanced/typesafe-schemas' },
{ label: 'JSON Schema Integration', href: '/documentation/ack/advanced/json-schema-integration' },
{ label: 'Configuration', href: '/documentation/ack/advanced/configuration' },
{ label: 'Adapter Package Quickstart', href: '/documentation/ack/advanced/schema-converter-quickstart' },
{ label: 'Creating Adapter Packages', href: '/documentation/ack/advanced/creating-schema-converter-packages' },
],
},
{
label: 'Reference',
pages: [
{ label: 'API Reference', href: '/documentation/ack/reference/api-reference' },
{ label: 'AI & llms.txt', href: '/documentation/ack/reference/llms-txt' },
],
},
],
}

function VersionMenu() {
Expand Down
39 changes: 39 additions & 0 deletions components/ProductFooter.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
'use client'

import Link from 'next/link'
import { usePathname } from 'next/navigation'

function isAckPath(pathname: string | null) {
return pathname === '/ack'
|| pathname?.startsWith('/ack/')
|| pathname?.startsWith('/documentation/ack')
}

export default function ProductFooter() {
const pathname = usePathname()

if (isAckPath(pathname)) {
return (
<div className="flex flex-col sm:flex-row items-center justify-between w-full gap-4 text-sm text-[var(--mix-text-muted)]">
<span>Built for trustworthy Dart boundaries.</span>
<div className="flex items-center gap-5">
<a href="https://github.com/btwld/ack" target="_blank" rel="noopener noreferrer" className="hover:text-white transition-colors">GitHub</a>
<a href="https://pub.dev/packages/ack" target="_blank" rel="noopener noreferrer" className="hover:text-white transition-colors">pub.dev</a>
<Link href="/ack/llms.txt" className="hover:text-white transition-colors">llms.txt</Link>
</div>
</div>
)
}

return (
<div className="flex flex-col sm:flex-row items-center justify-between w-full gap-4 text-sm text-[var(--mix-text-muted)]">
<span>&copy; 2026 Concepta Tech.</span>
<div className="flex items-center gap-5">
<a href="https://github.com/btwld/mix" target="_blank" rel="noopener noreferrer" className="hover:text-white transition-colors">GitHub</a>
<a href="https://pub.dev/packages/mix" target="_blank" rel="noopener noreferrer" className="hover:text-white transition-colors">pub.dev</a>
<a href="https://discord.com/invite/Ycn6GV3m2k" target="_blank" rel="noopener noreferrer" className="hover:text-white transition-colors">Discord</a>
<a href="https://twitter.com/leoafarias" target="_blank" rel="noopener noreferrer" className="hover:text-white transition-colors">Twitter</a>
</div>
</div>
)
}
Loading
Loading