Skip to content

Commit 19236ae

Browse files
authored
Comms for new docs site (#934)
* added note to component pages and homepages * add back in component layout * update note on hp
1 parent 5dc4401 commit 19236ae

File tree

3 files changed

+60
-11
lines changed

3 files changed

+60
-11
lines changed

src/@primer/gatsby-theme-doctocat/components/hero.js

+31-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
import {Text, Box, Heading, ThemeProvider} from '@primer/react'
1+
import {Text, Box, Heading, ThemeProvider, Link} from '@primer/react'
22
import React from 'react'
33
import {Container} from '@primer/gatsby-theme-doctocat'
44

@@ -7,6 +7,36 @@ export default function Hero() {
77
<ThemeProvider colorMode="night" nightScheme="dark_dimmed">
88
<Box pt={3}>
99
<Container>
10+
{/* Temporary banner before site is decomissioned, it is intended to mirror the Note component that shows up on component pages */}
11+
<Box
12+
sx={{
13+
backgroundColor: '#ddf4ff', //bgColor-accent-muted
14+
borderColor: '#54aeff66', //borderColor-accent-muted
15+
borderLeftWidth: '6px',
16+
borderLeftStyle: 'solid',
17+
borderStyle: 'solid',
18+
borderRightWidth: '0',
19+
borderTopWidth: '0',
20+
borderBottomWidth: 0,
21+
padding: 3,
22+
borderRadius: 2,
23+
marginBottom: 3,
24+
}}
25+
>
26+
<Text sx={{display: 'block'}}>
27+
🎉 👀 New look, same Primer!{' '}
28+
<Link
29+
href="https://primer-docs-preview.github.com"
30+
target="_blank"
31+
sx={{
32+
color: '#0969da !important',
33+
}}
34+
>
35+
Preview the new docs experience here
36+
</Link>{' '}
37+
and let us know what you think.
38+
</Text>
39+
</Box>
1040
<Box
1141
sx={{
1242
display: 'flex',

src/components/base-layout.tsx

+14-1
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
1-
import {Box} from '@primer/react'
1+
import {Box, Text, Link} from '@primer/react'
22
import React from 'react'
33
import Head from '@primer/gatsby-theme-doctocat/src/components/head'
44
import Header from '@primer/gatsby-theme-doctocat/src/components/header'
55
import Sidebar from '@primer/gatsby-theme-doctocat/src/components/sidebar'
6+
import {Note} from '@primer/gatsby-theme-doctocat'
7+
import {LinkExternalIcon} from '@primer/octicons-react'
68

79
export function BaseLayout({title, description, children, showSidebar = true}) {
810
return (
@@ -16,6 +18,17 @@ export function BaseLayout({title, description, children, showSidebar = true}) {
1618
</Box>
1719
) : null}
1820
<Box as="main" sx={{minWidth: 0, width: '100%'}} id="skip-nav">
21+
<Box sx={{maxWidth: 1200, width: '100%', pt: [4, 5, 6, 7], px: [4, 5, 6, 7], pb: 0, mx: 'auto'}}>
22+
<Note>
23+
<Text sx={{display: 'block'}}>
24+
🎉 👀 New look, same Primer!{' '}
25+
<Link href="https://primer-docs-preview.github.com" target="_blank">
26+
Preview the new docs experience here
27+
</Link>{' '}
28+
and let us know what you think.
29+
</Text>
30+
</Note>
31+
</Box>
1932
{children}
2033
</Box>
2134
</Box>

src/layouts/component-layout.tsx

+15-9
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@ import {ComponentPageNav} from '../components/component-page-nav'
99
import navItems from '@primer/gatsby-theme-doctocat/src/nav.yml'
1010

1111
type NavItemData = {
12-
title: string,
13-
url?: string,
12+
title: string
13+
url?: string
1414
children?: NavItemData[]
1515
}
1616

@@ -45,17 +45,23 @@ export default function ComponentLayout({pageContext, children, path}) {
4545

4646
return (
4747
<BaseLayout title={title} description={description}>
48-
<Box sx={{maxWidth: 1200, width: '100%', p: [4, 5, 6, 7], mx: 'auto'}}>
48+
<Box sx={{maxWidth: 1200, width: '100%', pb: [4, 5, 6, 7], px: [4, 5, 6, 7], pt: [2, 3, 4, 5], mx: 'auto'}}>
4949
{breadcrumbData.length > 1 ? (
5050
<Breadcrumbs sx={{mb: 4}}>
51-
{breadcrumbData.map(item => item.url ? (
52-
<Breadcrumbs.Item key={item.url} href={withPrefix(item.url)} selected={path === item.url}>
53-
{item.title}
54-
</Breadcrumbs.Item>
55-
): null).filter(item => item)}
51+
{breadcrumbData
52+
.map(item =>
53+
item.url ? (
54+
<Breadcrumbs.Item key={item.url} href={withPrefix(item.url)} selected={path === item.url}>
55+
{item.title}
56+
</Breadcrumbs.Item>
57+
) : null,
58+
)
59+
.filter(item => item)}
5660
</Breadcrumbs>
5761
) : null}
58-
<Heading as="h1" sx={{fontSize: 7}}>{title}</Heading>
62+
<Heading as="h1" sx={{fontSize: 7}}>
63+
{title}
64+
</Heading>
5965
{description ? (
6066
<Text as="p" sx={{fontSize: 3, m: 0, mb: 3, maxWidth: '60ch'}}>
6167
{description}

0 commit comments

Comments
 (0)