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.

Sign up for GitHub

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

Jump to bottom

fix: resolved the links that were inactive on pressing the "edit-this-page" for view docs #3221 #3468

Closed
wants to merge 1 commit into from
Closed

fix: resolved the links that were inactive on pressing the "edit-this-page" for view docs #3221 #3468

wants to merge 1 commit into from

Conversation

BiradarScripts
Copy link

@BiradarScripts BiradarScripts commented Dec 13, 2024 •
edited
Loading

Description

  • Fixed the links that were not working for the files of docs/tools/generator and docs/tools/cli
  • There was an unnecessary json in the config/edit-page-config.json file,removed them
  • Resolved the issue where the "Edit this page on GitHub" link was not functioning correctly. It is now fixed and working as intended.

Related issue(s)
Fixes #3221

Summary by CodeRabbit

  • New Features
    • Updated configuration by removing links to the AsyncAPI generator and CLI documentation.
  • Bug Fixes
    • Cleaned up outdated references in the edit page configuration.

@coderabbitai coderabbitai
Copy link

coderabbitai bot commented Dec 13, 2024 •
edited
Loading

Walkthrough

The changes involve the removal of two objects from a JSON array in the config/edit-page-config.json file. The first object, which linked to the AsyncAPI generator documentation, and the second, which linked to the AsyncAPI CLI documentation, have been deleted. The remaining objects in the array continue to reference the AsyncAPI specification and other relevant links.

Changes

File Change Summary
config/edit-page-config.json Removed two objects: one for AsyncAPI generator documentation and one for CLI documentation.

Assessment against linked issues

Objective Addressed Explanation
Fix links in Edit this page on GitHub (3221) ❌ The removed links may not address the issue fully.

Possibly related PRs

Suggested labels

ready-to-merge

Suggested reviewers

  • derberg
  • magicmatatjahu
  • devilkiller-ag
  • akshatnema
  • sambhavgupta0705
  • anshgoyalevil
  • Mayaleeeee
  • asyncapi-bot-eve

🐇 In the JSON forest, two links took flight,
To the AsyncAPI docs, they said goodnight.
With a hop and a skip, they’re gone from our sight,
Leaving behind paths that still feel just right.
So here’s to the changes, let’s keep it all bright! 🌟

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 0349217 and dffe107.

📒 Files selected for processing (1)
  • config/edit-page-config.json (0 hunks)
💤 Files with no reviewable changes (1)
  • config/edit-page-config.json

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 generate docstrings to generate docstrings for this PR. (Experiment)
  • @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.

github-actions[bot]
github-actions bot reviewed Dec 13, 2024
View reviewed changes
Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Welcome to AsyncAPI. Thanks a lot for creating your first pull request. Please check out our contributors guide useful for opening a pull request.
Keep in mind there are also other channels you can use to interact with AsyncAPI community. For more details check out this issue.

@netlify Netlify
Copy link

netlify bot commented Dec 13, 2024 •
edited
Loading

✅ Deploy Preview for asyncapi-website ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit dffe107
🔍 Latest deploy log https://app.netlify.com/sites/asyncapi-website/deploys/675c425321a796000870431f
😎 Deploy Preview https://deploy-preview-3468--asyncapi-website.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.

@codecov Codecov
Copy link

codecov bot commented Dec 13, 2024 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 77.22%. Comparing base (0349217) to head (dffe107).
Report is 2 commits behind head on master.

Additional details and impacted files 
@@           Coverage Diff           @@
##           master    #3468   +/-   ##
=======================================
  Coverage   77.22%   77.22%           
=======================================
  Files          21       21           
  Lines         663      663           
=======================================
  Hits          512      512           
  Misses        151      151

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@asyncapi-bot
Copy link
Contributor

asyncapi-bot commented Dec 13, 2024 •
edited
Loading

⚡️ Lighthouse report for the changes in this PR:

Category Score
🔴 Performance 47
🟢 Accessibility 98
🟢 Best practices 92
🟢 SEO 100
🔴 PWA 33

Lighthouse ran on https://deploy-preview-3468--asyncapi-website.netlify.app/

@BiradarScripts BiradarScripts changed the title fix: Resolved the links that were inactive on pressing the "edit-this-page" for view docs #3221 fix: resolved the links that were inactive on pressing the "edit-this-page" for view docs #3221 Dec 13, 2024
@BiradarScripts
Copy link
Author

@asyncapi-bot @scharrier @antoniogarrote @MikeRalphson can you please review this pr

@akshatnema
Copy link
Member

@BiradarScripts Closing this PR as it is not the correct way to fix this functionality. These docs are not maintained in the website repo. Moreover, we have pushed this issue into Bounty program, hence it will be taken by someone else.

@akshatnema akshatnema closed this Dec 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@github-actions github-actions[bot] github-actions[bot] left review comments

@derberg derberg Awaiting requested review from derberg derberg is a code owner

@akshatnema akshatnema Awaiting requested review from akshatnema akshatnema is a code owner

@magicmatatjahu magicmatatjahu Awaiting requested review from magicmatatjahu magicmatatjahu is a code owner

@anshgoyalevil anshgoyalevil Awaiting requested review from anshgoyalevil anshgoyalevil is a code owner

@Mayaleeeee Mayaleeeee Awaiting requested review from Mayaleeeee Mayaleeeee is a code owner

@asyncapi-bot-eve asyncapi-bot-eve Awaiting requested review from asyncapi-bot-eve asyncapi-bot-eve is a code owner

@devilkiller-ag devilkiller-ag Awaiting requested review from devilkiller-ag

@sambhavgupta0705 sambhavgupta0705 Awaiting requested review from sambhavgupta0705

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Refactor the edit-this-page-on-github workflow
3 participants
@BiradarScripts @asyncapi-bot @akshatnema