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

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

Open
benjagm opened this issue Oct 27, 2024 · 3 comments
Open
Assignees
Labels
✨ Enhancement Indicates that the issue suggests an improvement or new feature. Hacktoberfest Issues accepeted Hacktoberfest'24 Status: In Progress This issue is being worked on, and has someone assigned.

Comments

@benjagm
Copy link
Collaborator

benjagm commented Oct 27, 2024

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.

Describe alternatives you've considered

No response

Additional context

No response

Are you working on this?

No

@benjagm benjagm added ✨ Enhancement Indicates that the issue suggests an improvement or new feature. Status: Triage This is the initial status for an issue that requires triage. labels Oct 27, 2024
@benjagm benjagm added Status: Available No one has claimed responsibility for resolving this issue. and removed Status: Triage This is the initial status for an issue that requires triage. labels Oct 27, 2024
@benjagm benjagm moved this to Waiting for Contributions in Website Contributor Board Oct 27, 2024
@github-actions github-actions bot added the Status: Triage This is the initial status for an issue that requires triage. label Oct 27, 2024
@benjagm benjagm removed the Status: Triage This is the initial status for an issue that requires triage. label Oct 27, 2024
@RonakSurana-2001
Copy link

RonakSurana-2001 commented Oct 28, 2024

I am interested on working on this issue. Can you please assign this issue to me?

@DhairyaMajmudar DhairyaMajmudar added the Hacktoberfest Issues accepeted Hacktoberfest'24 label Oct 28, 2024
@DhairyaMajmudar DhairyaMajmudar added Status: In Progress This issue is being worked on, and has someone assigned. and removed Status: Available No one has claimed responsibility for resolving this issue. labels Oct 28, 2024
@DhairyaMajmudar
Copy link
Member

Assigned the issue to you @RonakSurana-2001 🚀

@RonakSurana-2001
Copy link

RonakSurana-2001 commented Oct 29, 2024

Please check PR #1084
I have added buttons to Overview only currently for you to check that am I going in correct direction of solving the issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
✨ Enhancement Indicates that the issue suggests an improvement or new feature. Hacktoberfest Issues accepeted Hacktoberfest'24 Status: In Progress This issue is being worked on, and has someone assigned.
Projects
Status: Waiting for Contributions
Development

No branches or pull requests

3 participants