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

fix(docs): Fixes gh link #3280

Merged
merged 3 commits into from
Oct 12, 2024
Merged

fix(docs): Fixes gh link #3280

merged 3 commits into from
Oct 12, 2024

Conversation

abtestingalpha
Copy link
Collaborator

@abtestingalpha abtestingalpha commented Oct 12, 2024

Summary by CodeRabbit

  • Documentation
    • Standardized formatting for navbar items in the Docusaurus configuration.
    • Updated the GitHub link in the footer to the new repository.
    • Removed unnecessary commented code to streamline the configuration.

415420e: docs preview link
2ee601b: docs preview link
c9a407b: docs preview link

Copy link
Contributor

coderabbitai bot commented Oct 12, 2024

Caution

Review failed

The pull request is closed.

Walkthrough

The changes involve modifications to the docusaurus.config.ts file for the Docusaurus documentation site. Key updates include standardizing the formatting of navbar items, updating the GitHub footer link to a new repository, removing commented-out code, and maintaining the overall structure without altering functionality.

Changes

File Change Summary
docs/bridge/docusaurus.config.ts - Standardized formatting of the blog link in the navbar.
- Updated GitHub footer link.
- Removed commented-out code related to the footer's "Docs" section.
- No changes to core functionality or configuration options.

Possibly related PRs

  • Dev Docs #2611: This PR involves updates to documentation paths, which may relate to the overall documentation structure changes in the main PR.
  • doc release fix #2631: Although primarily focused on deployment steps, it involves the documentation workflow, which could connect with the changes made in the main PR.
  • update grafana docs links #3111: This PR updates links in documentation, which aligns with the main PR's focus on updating references in the Docusaurus configuration.
  • Docs/fix #3222: This PR includes updates to documentation that enhance clarity, similar to the main PR's focus on formatting and structure.
  • Docs/blog api img #3249: This PR introduces a new image for a blog post, which relates to the main PR's updates to the blog section in the Docusaurus configuration.

Suggested reviewers

  • dwasse

Poem

In the garden of code, where the rabbits play,
We tidy our scripts, keep the clutter at bay.
With links that now point to the right place,
Our Docusaurus shines with a fresh, happy face! 🐇✨
Formatting neat, like a well-trimmed hedge,
We hop through the changes, on the documentation edge!


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.

Copy link

codecov bot commented Oct 12, 2024

Bundle Report

Changes will decrease total bundle size by 3.91MB (-10.96%) ⬇️. This is within the configured threshold ✅

Detailed changes
Bundle name Size Change
sdk-router-@synapsecns/sdk-router-esm* 255.26kB 609 bytes (0.24%) ⬆️
sdk-router-@synapsecns/sdk-router-cjs* 117.55kB 312 bytes (0.27%) ⬆️
explorer-ui-server-cjs* 708.77kB 157.29kB (-18.16%) ⬇️
explorer-ui-client-array-push* 2.15MB 162.81kB (-7.04%) ⬇️
synapse-interface-client-array-push* 7.38MB 100.39kB (1.38%) ⬆️
synapse-interface-server-cjs* 1.65MB 151.21kB (10.12%) ⬆️
widget-cjs-esm* 271.27kB 2.03kB (-0.74%) ⬇️
docs-bridge-client-array-push 7.28MB 619.55kB (-7.84%) ⬇️
docs-bridge-server-cjs 11.31MB 3.57MB (-23.98%) ⬇️
synapse-constants-esm-cjs* 174.63kB 174.63kB (100%) ⬆️
synapse-constants-cjs-esm* 174.18kB 174.18kB (100%) ⬆️

ℹ️ *Bundle size includes cached data from a previous commit

Copy link

cloudflare-workers-and-pages bot commented Oct 12, 2024

Deploying sanguine-fe with  Cloudflare Pages  Cloudflare Pages

Latest commit: 9090499
Status:⚡️  Build in progress...

View logs

@trajan0x trajan0x merged commit f1dfc82 into master Oct 12, 2024
28 of 29 checks passed
@trajan0x trajan0x deleted the docs/fix-link branch October 12, 2024 22:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants