Skip to content

New structure #161

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
merged 12 commits into from
Jul 11, 2022
Merged

New structure #161

Show file tree
Hide file tree
Changes from 11 commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
ea44fa1
First pass at new structure (in English only for now)
benface Jun 17, 2022
414be06
New structure in all languages
benface Jun 17, 2022
7fe8239
Update dependencies
benface Jun 17, 2022
7aa0d05
Update links
benface Jun 17, 2022
9e27257
Add redirects
benface Jun 17, 2022
3d4ce07
More consistent page titles and URLs
benface Jun 17, 2022
48b15ba
Add “Subgraphs” heading to navigation
benface Jun 17, 2022
d89050f
Update dependencies
benface Jun 20, 2022
dc6e506
Rename “The Graph Explorer” to “Graph Explorer”
benface Jun 30, 2022
24c2cf2
Rename “Network” to “The Graph Network”
benface Jun 30, 2022
61904ba
Update dependencies
benface Jun 30, 2022
8559659
Consolidate Supported Networks list (#166)
benface Jul 11, 2022
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
10 changes: 10 additions & 0 deletions components/NavTree.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ export type NavTreeGroupHeadingProps = HTMLAttributes<HTMLElement> & {
}
export type NavTreeGroupContentProps = HTMLAttributes<HTMLElement>
export type NavTreeDividerProps = Omit<HTMLAttributes<HTMLElement>, 'children'>
export type NavTreeHeadingProps = HTMLAttributes<HTMLElement>

const NavTree = ({ children, textProps, ...props }: NavTreeProps) => {
return (
Expand Down Expand Up @@ -182,10 +183,19 @@ const NavTreeDivider = (props: NavTreeDividerProps) => {
)
}

const NavTreeHeading = ({ children, ...props }: NavTreeHeadingProps) => {
return (
<li sx={{ mt: Spacing.XL, mb: Spacing.M_L, pl: Spacing.L_XL }} {...props}>
<Text.C12 color="White48">{children}</Text.C12>
</li>
)
}

NavTree.Item = NavTreeItem
NavTree.Group = NavTreeGroup
NavTreeGroup.Heading = NavTreeGroupHeading
NavTreeGroup.Content = NavTreeGroupContent
NavTree.Divider = NavTreeDivider
NavTree.Heading = NavTreeHeading

export { NavTree }
1 change: 1 addition & 0 deletions layout/DocumentContext.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ import { createContext, Context } from 'react'

export type Frontmatter = {
title?: string
navTitle?: string
}

export type OutlineItem = {
Expand Down
2 changes: 1 addition & 1 deletion layout/MDXLayout.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,7 @@ export const MDXLayout = ({ pagePath, navItems, frontmatter, outline, children }
<div
sx={{
display: ['flex', null, null, 'grid'],
gridTemplateColumns: '216px auto 216px',
gridTemplateColumns: '244px auto 216px',
flexDirection: 'column',
}}
>
Expand Down
3 changes: 3 additions & 0 deletions layout/MDXLayoutNav.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -166,6 +166,9 @@ export const MDXLayoutNav = ({ mobile = false }: { mobile?: boolean }) => {
if ('divider' in navItem) {
return <NavTree.Divider sx={mobile ? { mx: Spacing.L_XL, my: Spacing.L } : {}} />
}
if ('heading' in navItem) {
return <NavTree.Heading>{navItem.heading}</NavTree.Heading>
}
if ('children' in navItem) {
return (
<NavTree.Group active={currentPage?.path.startsWith(navItem.path)}>
Expand Down
144 changes: 87 additions & 57 deletions navigation/navigation.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,137 +1,155 @@
import { NavItemDefinition } from './types'
import { AppLocale, translations } from '@/i18n'

export const navigation: (locale: AppLocale) => NavItemDefinition[] = (locale) => [
export const navigation = (locale: AppLocale): NavItemDefinition[] => [
{
slug: '',
},
{
title: translations[locale].global.aboutTheGraph,
divider: true,
},
{
slug: 'about',
},
{
title: translations[locale].global.navigation.theGraphNetwork,
slug: 'network',
children: [
{
slug: 'introduction',
slug: 'overview',
},
{
slug: 'indexing',
},
{
slug: 'delegating',
},
{
slug: 'curating',
},
{
slug: 'network',
slug: 'explorer',
},
],
},
{
divider: true,
},
{
title: translations[locale].global.developer,
slug: 'developer',
heading: translations[locale].global.navigation.subgraphs,
},
{
title: translations[locale].global.navigation.developing,
slug: 'developing',
children: [
{
slug: 'quick-start',
slug: 'defining-a-subgraph',
},
{
slug: 'define-subgraph-hosted',
slug: 'creating-a-subgraph',
},
{
slug: 'create-subgraph-hosted',
slug: 'assemblyscript-api',
},
{
slug: 'publish-subgraph',
slug: 'unit-testing-framework',
},
{
slug: 'query-the-graph',
slug: 'developer-faqs',
},
],
},
{
title: translations[locale].global.navigation.deploying,
slug: 'deploying',
children: [
{
slug: 'querying-from-your-app',
slug: 'subgraph-studio',
},
{
slug: 'distributed-systems',
slug: 'deploying-a-subgraph-to-studio',
},
{
slug: 'assemblyscript-api',
slug: 'subgraph-studio-faqs',
},
{
slug: 'assemblyscript-migration-guide',
slug: 'hosted-service',
},
{
slug: 'graphql-api',
slug: 'deploying-a-subgraph-to-hosted',
},
],
},
{
title: translations[locale].global.navigation.publishing,
slug: 'publishing',
children: [
{
slug: 'matchstick',
slug: 'publishing-a-subgraph',
},
],
},
{
title: translations[locale].global.navigation.managing,
slug: 'managing',
children: [
{
slug: 'subgraph-debug-forking',
slug: 'transferring-subgraph-ownership',
},
{
slug: 'deprecating-a-subgraph',
},
{
slug: 'developer-faq',
},
],
},
{
slug: 'indexing',
},
{
slug: 'delegating',
},
{
slug: 'curating',
},
{
divider: true,
},
{
title: 'Subgraph Studio',
slug: 'studio',
title: translations[locale].global.navigation.querying,
slug: 'querying',
children: [
{
slug: 'subgraph-studio',
slug: 'querying-the-graph',
},
{
slug: 'deploy-subgraph-studio',
slug: 'managing-api-keys',
},
{
slug: 'billing',
slug: 'querying-from-an-application',
},
{
slug: 'managing-api-keys',
slug: 'querying-best-practices',
},
{
slug: 'studio-faq',
slug: 'distributed-systems',
},
{
slug: 'transferring-subgraph-ownership',
slug: 'graphql-api',
},
{
slug: 'querying-the-hosted-service',
},
{
slug: 'billing',
},
],
},
{
slug: 'explorer',
divider: true,
},
{
title: 'Hosted Service',
slug: 'hosted-service',
title: translations[locale].global.navigation.cookbook,
slug: 'cookbook',
children: [
{
slug: 'what-is-hosted-service',
slug: 'quick-start',
},
{
slug: 'deploy-subgraph-hosted',
slug: 'migrating-a-subgraph',
},
{
slug: 'query-hosted-service',
slug: 'multisig',
},
{
slug: 'migrating-subgraph',
slug: 'subgraph-debug-forking',
},
],
},
{
divider: true,
},
{
title: translations[locale].global.supportedNetworks,
slug: 'supported-networks',
children: [
{
slug: 'near',
},
Expand All @@ -143,4 +161,16 @@ export const navigation: (locale: AppLocale) => NavItemDefinition[] = (locale) =
},
],
},
{
divider: true,
},
{
title: translations[locale].global.navigation.releaseNotes,
slug: 'release-notes',
children: [
{
slug: 'assemblyscript-migration-guide',
},
],
},
]
10 changes: 7 additions & 3 deletions navigation/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,10 @@ export type NavItemDivider = {
divider: true
}

export type NavItem = NavItemPage | NavItemGroup | NavItemDivider
export type NavItemPromise = NavItemPagePromise | NavItemGroupPromise | NavItemDivider
export type NavItemDefinition = NavItemPageDefinition | NavItemGroupDefinition | NavItemDivider
export type NavItemHeading = {
heading: string
}

export type NavItem = NavItemPage | NavItemGroup | NavItemDivider | NavItemHeading
export type NavItemPromise = NavItemPagePromise | NavItemGroupPromise | NavItemDivider | NavItemHeading
export type NavItemDefinition = NavItemPageDefinition | NavItemGroupDefinition | NavItemDivider | NavItemHeading
13 changes: 5 additions & 8 deletions navigation/utils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ export const getNavItems = async (locale: AppLocale = defaultLocale): Promise<Na

navItemsPromise = (async () => {
const handleDefinition = (definition: NavItemDefinition, parentPath?: string): NavItemPromise => {
if ('divider' in definition) {
if ('divider' in definition || 'heading' in definition) {
return definition
}
const path = `${parentPath ?? ''}/${definition.slug}`
Expand All @@ -38,11 +38,8 @@ export const getNavItems = async (locale: AppLocale = defaultLocale): Promise<Na
const { frontmatter }: { frontmatter?: Frontmatter | ((locale: AppLocale) => Frontmatter) } =
await import(`../pages/${fileToTry}`)
if (!title && frontmatter) {
if (typeof frontmatter === 'function') {
title = frontmatter(locale).title
} else {
title = frontmatter.title
}
const frontmatterData = typeof frontmatter === 'function' ? frontmatter(locale) : frontmatter
title = frontmatterData.navTitle ?? frontmatterData.title
}
break
} catch (error) {
Expand Down Expand Up @@ -123,8 +120,8 @@ export const getNavItems = async (locale: AppLocale = defaultLocale): Promise<Na
filteredItems.shift()
}

// If the filtered items end with a divider due to missing pages/groups, remove it
if (filteredItems.length > 0 && 'divider' in (filteredItems[filteredItems.length - 1] as NavItem)) {
// If the filtered items end with a divider or a heading due to missing pages/groups, remove it
if (lastFilteredItem && ('divider' in lastFilteredItem || 'heading' in lastFilteredItem)) {
filteredItems.pop()
}

Expand Down
36 changes: 36 additions & 0 deletions nginx.conf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,42 @@ http {
rewrite ^/docs/hostedservice/(.*)$ $scheme://$http_host/docs/en/hosted-service/$1 permanent;
rewrite ^/docs/(?!(?:[a-zA-Z][a-zA-Z]|_next|img)(?:/|$))(.*)$ $scheme://$http_host/docs/en/$1 permanent; # Redirect to `/en` if no language in URL and not an asset URL

rewrite ^/docs/([a-zA-Z][a-zA-Z])/about/introduction/$ $scheme://$http_host/docs/$1/about/ permanent;
rewrite ^/docs/([a-zA-Z][a-zA-Z])/about/network/$ $scheme://$http_host/docs/$1/network/overview/ permanent;
rewrite ^/docs/([a-zA-Z][a-zA-Z])/curating/$ $scheme://$http_host/docs/$1/network/curating/ permanent;
rewrite ^/docs/([a-zA-Z][a-zA-Z])/delegating/$ $scheme://$http_host/docs/$1/network/delegating/ permanent;
rewrite ^/docs/([a-zA-Z][a-zA-Z])/developer/assemblyscript-api/$ $scheme://$http_host/docs/$1/developing/assemblyscript-api/ permanent;
rewrite ^/docs/([a-zA-Z][a-zA-Z])/developer/assemblyscript-migration-guide/$ $scheme://$http_host/docs/$1/release-notes/assemblyscript-migration-guide/ permanent;
rewrite ^/docs/([a-zA-Z][a-zA-Z])/developer/create-subgraph-hosted/$ $scheme://$http_host/docs/$1/developing/creating-a-subgraph/ permanent;
rewrite ^/docs/([a-zA-Z][a-zA-Z])/developer/define-subgraph-hosted/$ $scheme://$http_host/docs/$1/developing/defining-a-subgraph/ permanent;
rewrite ^/docs/([a-zA-Z][a-zA-Z])/developer/deprecating-a-subgraph/$ $scheme://$http_host/docs/$1/managing/deprecating-a-subgraph/ permanent;
rewrite ^/docs/([a-zA-Z][a-zA-Z])/developer/developer-faq/$ $scheme://$http_host/docs/$1/developing/developer-faqs/ permanent;
rewrite ^/docs/([a-zA-Z][a-zA-Z])/developer/distributed-systems/$ $scheme://$http_host/docs/$1/querying/distributed-systems/ permanent;
rewrite ^/docs/([a-zA-Z][a-zA-Z])/developer/graphql-api/$ $scheme://$http_host/docs/$1/querying/graphql-api/ permanent;
rewrite ^/docs/([a-zA-Z][a-zA-Z])/developer/matchstick/$ $scheme://$http_host/docs/$1/developing/unit-testing-framework/ permanent;
rewrite ^/docs/([a-zA-Z][a-zA-Z])/developer/publish-subgraph/$ $scheme://$http_host/docs/$1/publishing/publishing-a-subgraph/ permanent;
rewrite ^/docs/([a-zA-Z][a-zA-Z])/developer/query-the-graph/$ $scheme://$http_host/docs/$1/querying/querying-the-graph/ permanent;
rewrite ^/docs/([a-zA-Z][a-zA-Z])/developer/querying-best-practices/$ $scheme://$http_host/docs/$1/querying/querying-best-practices/ permanent;
rewrite ^/docs/([a-zA-Z][a-zA-Z])/developer/querying-from-your-app/$ $scheme://$http_host/docs/$1/querying/querying-from-an-application/ permanent;
rewrite ^/docs/([a-zA-Z][a-zA-Z])/developer/quick-start/$ $scheme://$http_host/docs/$1/cookbook/quick-start/ permanent;
rewrite ^/docs/([a-zA-Z][a-zA-Z])/developer/subgraph-debug-forking/$ $scheme://$http_host/docs/$1/cookbook/subgraph-debug-forking/ permanent;
rewrite ^/docs/([a-zA-Z][a-zA-Z])/explorer/$ $scheme://$http_host/docs/$1/network/explorer/ permanent;
rewrite ^/docs/([a-zA-Z][a-zA-Z])/hosted-service/deploy-subgraph-hosted/$ $scheme://$http_host/docs/$1/deploying/deploying-a-subgraph-to-hosted/ permanent;
rewrite ^/docs/([a-zA-Z][a-zA-Z])/hosted-service/migrating-subgraph/$ $scheme://$http_host/docs/$1/cookbook/migrating-a-subgraph/ permanent;
rewrite ^/docs/([a-zA-Z][a-zA-Z])/hosted-service/query-hosted-service/$ $scheme://$http_host/docs/$1/querying/querying-the-hosted-service/ permanent;
rewrite ^/docs/([a-zA-Z][a-zA-Z])/hosted-service/what-is-hosted-service/$ $scheme://$http_host/docs/$1/deploying/hosted-service/ permanent;
rewrite ^/docs/([a-zA-Z][a-zA-Z])/indexing/$ $scheme://$http_host/docs/$1/network/indexing/ permanent;
rewrite ^/docs/([a-zA-Z][a-zA-Z])/studio/billing/$ $scheme://$http_host/docs/$1/querying/billing/ permanent;
rewrite ^/docs/([a-zA-Z][a-zA-Z])/studio/deploy-subgraph-studio/$ $scheme://$http_host/docs/$1/deploying/deploying-a-subgraph-to-studio/ permanent;
rewrite ^/docs/([a-zA-Z][a-zA-Z])/studio/managing-api-keys/$ $scheme://$http_host/docs/$1/querying/managing-api-keys/ permanent;
rewrite ^/docs/([a-zA-Z][a-zA-Z])/studio/multisig/$ $scheme://$http_host/docs/$1/cookbook/multisig/ permanent;
rewrite ^/docs/([a-zA-Z][a-zA-Z])/studio/studio-faq/$ $scheme://$http_host/docs/$1/deploying/subgraph-studio-faqs/ permanent;
rewrite ^/docs/([a-zA-Z][a-zA-Z])/studio/subgraph-studio/$ $scheme://$http_host/docs/$1/deploying/subgraph-studio/ permanent;
rewrite ^/docs/([a-zA-Z][a-zA-Z])/studio/transferring-subgraph-ownership/$ $scheme://$http_host/docs/$1/managing/transferring-subgraph-ownership/ permanent;
rewrite ^/docs/([a-zA-Z][a-zA-Z])/supported-networks/arweave/$ $scheme://$http_host/docs/$1/cookbook/arweave/ permanent;
rewrite ^/docs/([a-zA-Z][a-zA-Z])/supported-networks/cosmos/$ $scheme://$http_host/docs/$1/cookbook/cosmos/ permanent;
rewrite ^/docs/([a-zA-Z][a-zA-Z])/supported-networks/near/$ $scheme://$http_host/docs/$1/cookbook/near/ permanent;

location / {
try_files $uri $uri.html $uri/index.html =404;

Expand Down
Loading