docs icon indicating copy to clipboard operation
docs copied to clipboard

Enable same-page navigation

Open krofax opened this issue 1 year ago • 2 comments

Description Enable same-page navigation on the SDK deprecation notice bar.

Tests

Additional context

Metadata

krofax avatar Oct 11 '24 19:10 krofax

Deploy Preview for docs-optimism ready!

Name Link
Latest commit 80cdbf88378ba51edc5dc5803ae7a73f344dec30
Latest deploy log https://app.netlify.com/sites/docs-optimism/deploys/6709836d2859670008cba06f
Deploy Preview https://deploy-preview-979--docs-optimism.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

netlify[bot] avatar Oct 11 '24 19:10 netlify[bot]

Walkthrough

The pull request introduces several modifications to the theme.config.tsx file, focusing on the documentation theme configuration. Key updates include changes to the banner link behavior, the integration of user feedback components, enhancements to SEO properties through dynamic meta tags, and the overall structure of the configuration remaining consistent with previous versions.

Changes

File Change Summary
theme.config.tsx - Modified banner link to open in the same tab by removing target="_blank".
- Integrated FeelbackYesNo component and PRESET_LIKE_DISLIKE into toc.extraContent.
- Defined useNextSeoProps for conditional title formatting based on the current path.
- Created head function for dynamic meta tags for Open Graph and Twitter cards.
- Retained existing configuration structure with properties like darkMode, search, etc.

Possibly related PRs

  • #801: This PR modifies the banner section in theme.config.tsx, which is directly related to the changes made in the main PR regarding the banner configuration.
  • #861: This PR adds meta tags for Open Graph and Twitter cards in theme.config.tsx, which aligns with the main PR's updates to SEO properties and head metadata in the same file.
  • #928: This PR introduces a new banner property in theme.config.tsx, which is relevant to the main PR's modifications to the banner configuration.

Suggested reviewers

  • cpengilly

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

coderabbitai[bot] avatar Oct 11 '24 20:10 coderabbitai[bot]