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

docs: WIP refactor #1917

Draft
wants to merge 1 commit into
base: develop
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 5 additions & 0 deletions docs/components/PkgLayout.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,11 @@ export function PkgLayout({
<Fragment>
{!pkg.unreleased ? (
<Prose>
<p>
{pkg.title} component(s) can be imported via the{' '}
<code>{pkg.name}</code> entrypoint in the{' '}
<code>@ag.ds-next/react</code> package.
</p>
<pre>
<code>{`import { ... } from '@ag.ds-next/react/${pkg.name}';`}</code>
</pre>
Expand Down
12 changes: 6 additions & 6 deletions docs/lib/mdx/packages.ts
Original file line number Diff line number Diff line change
Expand Up @@ -38,10 +38,15 @@ async function getPkgSubNavItems(slug: string) {
const meta = pkgNavMetaData(slug, data);
return [
{
label: 'Overview',
label: 'Usage',
href: `/components/${meta.slug}`,
path: pkgReadmePath(slug),
},
{
label: 'Props',
href: `/components/${meta.slug}/code`,
path: `${pkgDocsPath(slug)}/code.mdx`,
},
{
label: 'Rationale',
href: `/components/${meta.slug}/rationale`,
Expand All @@ -52,11 +57,6 @@ async function getPkgSubNavItems(slug: string) {
href: `/components/${meta.slug}/content`,
path: `${pkgDocsPath(slug)}/content.mdx`,
},
{
label: 'Code',
href: `/components/${meta.slug}/code`,
path: `${pkgDocsPath(slug)}/code.mdx`,
},
{
label: 'Accessibility',
href: `/components/${meta.slug}/accessibility`,
Expand Down
10 changes: 0 additions & 10 deletions docs/pages/components/[slug]/code.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -46,16 +46,6 @@ export default function PackagesCode({
]}
/>
<Prose id="pkg-content">
<h2 id="usage">Usage</h2>
<p>
{pkg.title} components can be imported via the{' '}
<code>{pkg.name}</code> entrypoint in the{' '}
<code>@ag.ds-next/react</code> package.
</p>
<p>For example:</p>
<pre>
<code>{`import { ... } from '@ag.ds-next/react/${pkg.name}';`}</code>
</pre>
<MDXRemote {...source} components={mdxComponents} />
<h2 id="source">Source</h2>
<p>
Expand Down
12 changes: 11 additions & 1 deletion docs/pages/components/[slug]/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ export default function Packages({
/>
) : null}
<Prose id="pkg-content">
<h2 id="overview">Overview</h2>
<MDXRemote {...source} components={mdxComponents} />
{relatedComponents?.length ? (
<Fragment>
Expand Down Expand Up @@ -137,7 +138,16 @@ export const getStaticProps: GetStaticProps<
pkg,
navLinks,
breadcrumbs,
toc,
toc: [
{
title: 'Overview',
slug: 'overview',
id: 'overview',
level: 2,
items: [],
},
...toc,
],
source: pkgContent.source,
relatedPatterns,
relatedComponents,
Expand Down
2 changes: 0 additions & 2 deletions packages/react/src/a11y/docs/code.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
## Props

<ComponentPropsTable name="VisuallyHidden" />

<ComponentPropsTable name="ExternalLinkCallout" />
2 changes: 0 additions & 2 deletions packages/react/src/accordion/docs/code.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
## Props

<ComponentPropsTable name="Accordion" />

<ComponentPropsTable name="AccordionItem" />
Expand Down
2 changes: 0 additions & 2 deletions packages/react/src/ag-branding/docs/code.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1 @@
## Props

<ComponentPropsTable name="Logo" />
2 changes: 0 additions & 2 deletions packages/react/src/app-layout/docs/code.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
## Props

<ComponentPropsTable name="AppLayout" />

<ComponentPropsTable name="AppLayoutHeader" />
Expand Down
2 changes: 0 additions & 2 deletions packages/react/src/autocomplete/docs/code.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
## Props

<ComponentPropsTable name="Autocomplete" />

<ComponentPropsTable name="AutocompleteRenderItem" />
2 changes: 0 additions & 2 deletions packages/react/src/avatar/docs/code.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1 @@
## Props

<ComponentPropsTable name="Avatar" />
2 changes: 0 additions & 2 deletions packages/react/src/box/docs/code.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1 @@
## Props

<ComponentPropsTable name="Box" />
2 changes: 0 additions & 2 deletions packages/react/src/breadcrumbs/docs/code.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1 @@
## Props

<ComponentPropsTable name="Breadcrumbs" />
2 changes: 0 additions & 2 deletions packages/react/src/button/docs/code.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
## Props

<ComponentPropsTable name="Button" />

<ComponentPropsTable name="ButtonLink" />
2 changes: 0 additions & 2 deletions packages/react/src/call-to-action/docs/code.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
## Props

<ComponentPropsTable name="CallToActionLink" />

<ComponentPropsTable name="CallToActionButton" />
2 changes: 0 additions & 2 deletions packages/react/src/callout/docs/code.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
## Props

<ComponentPropsTable name="Callout" />

<ComponentPropsTable name="CalloutTitle" />
2 changes: 0 additions & 2 deletions packages/react/src/card/docs/code.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
## Props

<ComponentPropsTable name="Card" />

<ComponentPropsTable name="CardInner" />
Expand Down
2 changes: 0 additions & 2 deletions packages/react/src/checkbox/docs/code.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1 @@
## Props

<ComponentPropsTable name="Checkbox" />
2 changes: 0 additions & 2 deletions packages/react/src/columns/docs/code.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
## Props

<ComponentPropsTable name="Columns" />

<ComponentPropsTable name="Column" />
2 changes: 0 additions & 2 deletions packages/react/src/combobox/docs/code.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
## Props

<ComponentPropsTable name="Combobox" />

<ComponentPropsTable name="ComboboxAsync" />
Expand Down
2 changes: 0 additions & 2 deletions packages/react/src/content/docs/code.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
## Props

<ComponentPropsTable name="PageContent" />

<ComponentPropsTable name="SectionContent" />
Expand Down
2 changes: 0 additions & 2 deletions packages/react/src/control-group/docs/code.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1 @@
## Props

<ComponentPropsTable name="ControlGroup" />
2 changes: 0 additions & 2 deletions packages/react/src/core/docs/code.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
## Props

<ComponentPropsTable name="Core" />

<ComponentPropsTable name="CoreProvider" />
2 changes: 0 additions & 2 deletions packages/react/src/date-picker/docs/code.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1 @@
## Props

<ComponentPropsTable name="DatePicker" />
2 changes: 0 additions & 2 deletions packages/react/src/date-range-picker/docs/code.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1 @@
## Props

<ComponentPropsTable name="DateRangePicker" />
2 changes: 0 additions & 2 deletions packages/react/src/details/docs/code.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1 @@
## Props

<ComponentPropsTable name="Details" />
2 changes: 0 additions & 2 deletions packages/react/src/direction-link/docs/code.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
## Props

<ComponentPropsTable name="DirectionLink" />

<ComponentPropsTable name="DirectionButton" />
2 changes: 0 additions & 2 deletions packages/react/src/divider/docs/code.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1 @@
## Props

<ComponentPropsTable name="Divider" />
2 changes: 0 additions & 2 deletions packages/react/src/drawer/docs/code.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1 @@
## Props

<ComponentPropsTable name="Drawer" />
2 changes: 0 additions & 2 deletions packages/react/src/dropdown-menu/docs/code.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
## Props

<ComponentPropsTable name="DropdownMenu" />

<ComponentPropsTable name="DropdownMenuButton" />
Expand Down
2 changes: 0 additions & 2 deletions packages/react/src/feature-link-list/docs/code.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1 @@
## Props

<ComponentPropsTable name="FeatureLinkList" />
2 changes: 0 additions & 2 deletions packages/react/src/field/docs/code.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
## Props

<ComponentPropsTable name="Field" />

<ComponentPropsTable name="FieldContainer" />
Expand Down
2 changes: 0 additions & 2 deletions packages/react/src/fieldset/docs/code.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
## Props

<ComponentPropsTable name="Fieldset" />

<ComponentPropsTable name="FieldsetLegend" />
2 changes: 0 additions & 2 deletions packages/react/src/file-input/docs/code.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1 @@
## Props

<ComponentPropsTable name="FileInput" />
2 changes: 0 additions & 2 deletions packages/react/src/file-upload/docs/code.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1 @@
## Props

<ComponentPropsTable name="FileUpload" />
2 changes: 0 additions & 2 deletions packages/react/src/filter-sidebar/docs/code.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1 @@
## Props

<ComponentPropsTable name="FilterSidebar" />
2 changes: 0 additions & 2 deletions packages/react/src/flex/docs/code.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1 @@
## Props

<ComponentPropsTable name="Flex" />
2 changes: 0 additions & 2 deletions packages/react/src/footer/docs/code.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
## Props

<ComponentPropsTable name="Footer" />

<ComponentPropsTable name="FooterDivider" />
2 changes: 0 additions & 2 deletions packages/react/src/form-stack/docs/code.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1 @@
## Props

<ComponentPropsTable name="FormStack" />
2 changes: 0 additions & 2 deletions packages/react/src/global-alert/docs/code.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1 @@
## Props

<ComponentPropsTable name="GlobalAlert" />
2 changes: 0 additions & 2 deletions packages/react/src/grouped-fields/docs/code.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1 @@
## Props

<ComponentPropsTable name="GroupedFields" />
2 changes: 0 additions & 2 deletions packages/react/src/header/docs/code.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1 @@
## Props

<ComponentPropsTable name="Header" />
2 changes: 0 additions & 2 deletions packages/react/src/heading/docs/code.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1 @@
## Props

<ComponentPropsTable name="Heading" />
2 changes: 0 additions & 2 deletions packages/react/src/hero-banner/docs/code.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
## Props

<ComponentPropsTable name="HeroBanner" />

<ComponentPropsTable name="HeroBannerTitleContainer" />
Expand Down
2 changes: 0 additions & 2 deletions packages/react/src/icon/docs/code.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1 @@
## Props

<ComponentPropsTable name="AvatarIcon" />
2 changes: 0 additions & 2 deletions packages/react/src/indicator-dot/docs/code.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1 @@
## Props

<ComponentPropsTable name="IndicatorDot" />
2 changes: 0 additions & 2 deletions packages/react/src/inpage-nav/docs/code.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1 @@
## Props

<ComponentPropsTable name="InpageNav" />
2 changes: 0 additions & 2 deletions packages/react/src/link-list/docs/code.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1 @@
## Props

<ComponentPropsTable name="LinkList" />
2 changes: 0 additions & 2 deletions packages/react/src/list/docs/code.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
## Props

<ComponentPropsTable name="UnorderedList" />

<ComponentPropsTable name="OrderedList" />
Expand Down
2 changes: 0 additions & 2 deletions packages/react/src/loading/docs/code.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
## Props

<ComponentPropsTable name="LoadingBlanket" />

<ComponentPropsTable name="LoadingDots" />
2 changes: 0 additions & 2 deletions packages/react/src/main-nav/docs/code.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1 @@
## Props

<ComponentPropsTable name="MainNav" />
2 changes: 0 additions & 2 deletions packages/react/src/modal/docs/code.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1 @@
## Props

<ComponentPropsTable name="Modal" />
2 changes: 0 additions & 2 deletions packages/react/src/notification-badge/docs/code.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1 @@
## Props

<ComponentPropsTable name="NotificationBadge" />
2 changes: 0 additions & 2 deletions packages/react/src/page-alert/docs/code.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
## Props

<ComponentPropsTable name="PageAlert" />

<ComponentPropsTable name="PageAlertTitle" />
2 changes: 0 additions & 2 deletions packages/react/src/pagination/docs/code.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
## Props

<ComponentPropsTable name="Pagination" />

<ComponentPropsTable name="PaginationButtons" />
2 changes: 0 additions & 2 deletions packages/react/src/password-input/docs/code.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1 @@
## Props

<ComponentPropsTable name="PasswordInput" />
2 changes: 0 additions & 2 deletions packages/react/src/progress-indicator/docs/code.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1 @@
## Props

<ComponentPropsTable name="ProgressIndicator" />
2 changes: 0 additions & 2 deletions packages/react/src/prose/docs/code.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1 @@
## Props

<ComponentPropsTable name="Prose" />
2 changes: 0 additions & 2 deletions packages/react/src/radio/docs/code.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1 @@
## Props

<ComponentPropsTable name="Radio" />
2 changes: 0 additions & 2 deletions packages/react/src/search-box/docs/code.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
## Props

<ComponentPropsTable name="SearchBox" />

<ComponentPropsTable name="SearchBoxInput" />
Expand Down
2 changes: 0 additions & 2 deletions packages/react/src/search-input/docs/code.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1 @@
## Props

<ComponentPropsTable name="SearchInput" />
2 changes: 0 additions & 2 deletions packages/react/src/section-alert/docs/code.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1 @@
## Props

<ComponentPropsTable name="SectionAlert" />
2 changes: 0 additions & 2 deletions packages/react/src/select/docs/code.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1 @@
## Props

<ComponentPropsTable name="Select" />
2 changes: 0 additions & 2 deletions packages/react/src/side-nav/docs/code.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1 @@
## Props

<ComponentPropsTable name="SideNav" />
2 changes: 0 additions & 2 deletions packages/react/src/skeleton/docs/code.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
## Props

<ComponentPropsTable name="SkeletonHeading" />

<ComponentPropsTable name="SkeletonText" />
Expand Down
2 changes: 0 additions & 2 deletions packages/react/src/skip-link/docs/code.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1 @@
## Props

<ComponentPropsTable name="SkipLinks" />
2 changes: 0 additions & 2 deletions packages/react/src/stack/docs/code.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1 @@
## Props

<ComponentPropsTable name="Stack" />
2 changes: 0 additions & 2 deletions packages/react/src/status-badge/docs/code.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1 @@
## Props

<ComponentPropsTable name="StatusBadge" />
2 changes: 0 additions & 2 deletions packages/react/src/sub-nav/docs/code.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1 @@
## Props

<ComponentPropsTable name="SubNav" />
2 changes: 0 additions & 2 deletions packages/react/src/summary-list/docs/code.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,6 @@ It is important that this component is composed correctly to ensure the correct
</SummaryList>
```

## Props

<ComponentPropsTable name="SummaryList" />
<ComponentPropsTable name="SummaryListItem" />
<ComponentPropsTable name="SummaryListItemTerm" />
Expand Down
Loading
Loading