Skip to content

docs: rename fxCore to Pundi AIFX#908

Merged
fx0x55 merged 1 commit intomainfrom
zakir/docs
Jan 16, 2025
Merged

docs: rename fxCore to Pundi AIFX#908
fx0x55 merged 1 commit intomainfrom
zakir/docs

Conversation

@zakir-web3
Copy link
Copy Markdown
Contributor

@zakir-web3 zakir-web3 commented Jan 16, 2025

Summary by CodeRabbit

  • Rebranding

    • Updated project name from "fxCore" to "Pundi AIFX" across multiple documentation files
    • Modified titles, headers, and URLs in README, documentation, and tool-related files
    • Updated references to explorer URLs from Starscan to Pundiscan
  • New Features

    • Added Base bridge information to supported bridges list
  • Documentation

    • Comprehensive renaming of project references in documentation files
    • Updated validator and development tool documentation

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Jan 16, 2025

Walkthrough

The pull request involves a comprehensive rebranding of the project from "fxCore" to "Pundi AIFX" across multiple documentation and configuration files. The changes span README files, documentation tools, HTML pages, JavaScript files, and Solidity contract documentation. The renaming is consistent throughout the project, updating titles, headers, URLs, and references to reflect the new project name while maintaining the existing functionality and structure of the files.

Changes

File Change Summary
README.md Project name changed from "fxcore" to "Pundi AIFX"
docs/README.md API and SDK section headers updated to "Pundi AIFX"
docs/config.json Documentation title updated to "Pundi AIFX REST and gRPC Gateway docs"
docs/tools/README.md Develop Tools header changed to "Pundi AIFX Develop Tools"
docs/tools/balances.html Title and JavaScript variables updated to "Pundi AIFX"
docs/tools/countdown.html Title and header changed to "Pundi AIFX"
docs/tools/js/constants.js Added new bridge entry for "base"
docs/tools/js/index.js Replaced getStarscanUrl() with getPundiscanUrl()
docs/tools/validator.html Updated title and validator URL
solidity/README.md Contracts header changed to "Pundi AIFX contracts"
solidity/upgrade.md Bridge Contract Upgrade Process title updated

Possibly related PRs

Poem

🐰 A Rabbit's Rebranding Rhyme 🚀

From fxCore to Pundi AIFX we leap,
Renaming docs with a technological sweep,
Bridges, tools, and contracts anew,
A name that sparkles, fresh and true!
Hop along, code rabbit's delight! 🌟

Finishing Touches

  • 📝 Generate Docstrings (Beta)

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. (Beta)
  • @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.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
docs/tools/validator.html (1)

86-86: Update path segment to match new branding.

The URL still contains "fxcore" in the path: ${getPundiscanUrl()}/fxcore/validator/${validator.operator_address}. Consider updating it to match the new branding.

-<td style="text-align: left"><a target="_blank" href="${getPundiscanUrl()}/fxcore/validator/${validator.operator_address}"><span class="${color}">${signInfo?.missed_blocks_counter}</span></a></td>
+<td style="text-align: left"><a target="_blank" href="${getPundiscanUrl()}/pundiaifx/validator/${validator.operator_address}"><span class="${color}">${signInfo?.missed_blocks_counter}</span></a></td>
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 70587c2 and 2fc0989.

📒 Files selected for processing (11)
  • README.md (1 hunks)
  • docs/README.md (2 hunks)
  • docs/config.json (1 hunks)
  • docs/tools/README.md (1 hunks)
  • docs/tools/balances.html (3 hunks)
  • docs/tools/countdown.html (3 hunks)
  • docs/tools/js/constants.js (1 hunks)
  • docs/tools/js/index.js (1 hunks)
  • docs/tools/validator.html (2 hunks)
  • solidity/README.md (1 hunks)
  • solidity/upgrade.md (1 hunks)
✅ Files skipped from review due to trivial changes (6)
  • docs/tools/README.md
  • solidity/upgrade.md
  • solidity/README.md
  • docs/README.md
  • README.md
  • docs/config.json
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: Mergify Merge Protections
  • GitHub Check: Summary
🔇 Additional comments (8)
docs/tools/js/constants.js (1)

32-37: Changes seem unrelated to the PR's rebranding objective.

This addition of a new bridge configuration appears unrelated to the PR's goal of renaming fxCore to Pundi AIFX. Consider:

  1. Moving this change to a separate PR focused on bridge additions
  2. Following the existing naming convention (capitalize "Base")
  3. Using a more specific denom_prefix (e.g., "base" instead of generic "layer2")
docs/tools/js/index.js (1)

30-36: Verify all references to getStarscanUrl are updated.

The function renaming from getStarscanUrl to getPundiscanUrl aligns with the rebranding. However, we should ensure all references are updated.

docs/tools/validator.html (1)

6-6: LGTM!

Title update aligns with the rebranding effort.

docs/tools/countdown.html (1)

7-7: LGTM!

All changes consistently reflect the rebranding from f(x)Core to Pundi AIFX:

  • Updated title
  • Updated header text
  • Updated URL function call

Also applies to: 119-121, 166-166

docs/tools/balances.html (4)

6-6: LGTM! Title change is consistent with rebranding.

The HTML title has been properly updated to reflect the new branding.


61-61: LGTM! Document title for total supply view is consistent.

The dynamic title setting maintains consistency with the new branding.


64-64: LGTM! Document title for ERC20 module view is consistent.

The dynamic title setting maintains consistency with the new branding.


142-142: Verify bridge configurations with the new blockchain name.

The default blockchain name has been updated. Please ensure that this change doesn't affect any bridge configurations or external integrations that might be expecting the old name.

Let's verify the bridge configurations:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants