Skip to content

✨ Enhancement: Implement the Prev / Next navigation in all the pages #1072

@benjagm

Description

@benjagm

Is your feature request related to a problem? Please describe

We implemented a component to enable Prev / Next navigation in our docs, however this component need to be enabled in all the pages.

The component is available here: components/NextPrevButton.tsx

Describe the solution you'd like

To implement it in all docs pages available in the sidebar, please follow these instructions:

  1. Add prev and next metadata to the markdown page following this format:
---
title: Creating your first schema
section: docs
prev: 
  label: prev
  url: '#1'
next: 
  label: Miscellaneous examples
  url: '#2'
---
  1. Add the component to the typescript page:
import NextPrevButton from '~/components/NextPrevButton';
  1. Add the component to the body of the page:
<NextPrevButton prevLabel={frontmatter.prev.label} prevURL={frontmatter.prev.url} nextLabel={frontmatter.next.label} nextURL={frontmatter.next.url} />

Some markdown files are symlink to the content of GitHub submodules, for example, the Sponsors page. In this case, it will be required to create a PR in the community repo to add the metadata to the original markdown and update _includes/community submodule to the latest version once it is merged.

Implementations steps:

We will create a new PR for each docs section:

Metadata

Metadata

Labels

Status: In ProgressThis issue is being worked on, and has someone assigned.✨ EnhancementIndicates that the issue suggests an improvement or new feature.

Type

No type

Projects

Status

Waiting for Contributions

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions