Draft
Conversation
…pages - Added getSectionNavigation helper to ApiReferenceLayout to compute prev/next sections - Added Page.ContentFooter with section navigation to ApiReferenceLayout - Added getSectionNavigation helper to CliReferenceLayout - Added Page.ContentFooter with section navigation to CliReferenceLayout - Added missing currentPath prop to api-reference and mapi-reference index pages This allows users to navigate between sections (e.g., from /api-reference/overview to /api-reference/workflows) using next/previous buttons at the bottom of the page. Co-authored-by: chris <chris@knock.app>
|
Cursor Agent can help with this pull request. Just |
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Co-authored-by: chris <chris@knock.app>
- Added useEffect to scroll to top when currentPath changes in ApiReferenceLayout - Added useEffect to scroll to top when resource changes in CliReferenceLayout - Removed unused useScrollToTop hook from CliReferenceLayout (was looking for non-existent .main-content class) Co-authored-by: chris <chris@knock.app>
This reverts commit 5e03be2.
|
Deployment failed with the following error: |
Contributor
Author
|
@cursor please fix isues with this PR |
|
I've analyzed the PR and here's what I found: PR StatusCode is working correctly:
The only issue was a transient Vercel deployment failure:
Summary of Changes in This PRThe PR adds next/previous section navigation to the API Reference, MAPI Reference, and CLI Reference pages:
The new deployment should complete shortly. You can monitor the progress in the Vercel dashboard or PR checks. |
Co-authored-by: Chris Bell <chris@cjbell.co>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.


Description
This PR introduces next/previous section navigation at the bottom of the API Reference, MAPI Reference, and CLI Reference pages.
Why:
To enhance the user experience and maintain consistency across the documentation, allowing users to easily navigate between top-level sections (e.g., Overview, Workflows, Messages) using the familiar
Page.ContentFootercomponent, aligning with the design of other docs pages.How:
getSectionNavigationhelper functions withinApiReferenceLayout.tsxandCliReferenceLayout.tsxto determine the correct previous and next sections based on the current page's path.Page.ContentFootercomponent into these layouts, passing the calculatedprevSectionandnextSectionprops.currentPathprops were correctly set for theindex.tsx(overview) pages of API and MAPI references to enable navigation from these entry points.Todos
Tasks
Screenshots