Skip to content

Fix API Reference formatting to match other boxes #920

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
Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Fix API Reference formatting to match other boxes #920

wants to merge 3 commits into from

Conversation

@devin-ai-integration
Copy link
Contributor

@devin-ai-integration devin-ai-integration bot commented Oct 22, 2025 •
edited
Loading

Description

Applied prettier formatting to the API Reference box in the Additional Resources section of the price feeds page. The PR went through two commits: an initial formatting change to match the single-line style of adjacent boxes, followed by automatic prettier reformatting per the pre-commit hook requirements.

Note: The net changes compared to the base branch may be minimal or none, as prettier reformatted the code back to its preferred multi-line style. Human review of the deployed preview is needed to verify this resolves the reported formatting inconsistency.

Type of Change

  • Page update/improvement
  • Fix typo/grammar

Areas Affected

  • pages/price-feeds/index.mdx - API Reference box in Additional Resources section

Checklist

  • I ran pre-commit run --all-files to check for linting errors
  • All links are valid and working
  • Content follows the established style guide
  • Changes are properly formatted in Markdown

Related Issues

Requested via Slack by @jayantk

Additional Notes

This PR addresses a formatting consistency request. However, there are some uncertainties:

  1. The initial change was reformatted by prettier (v2.7.1 in pre-commit), potentially reverting to the original state
  2. The "Vercel – documentation" deployment failed (though "Vercel – docs" succeeded)
  3. The issue was reported on the production site but could not be reproduced locally

Contributor Information

Human Review Checklist

Critical items to verify:

  • View the deployed preview and compare the API Reference box formatting to the Price Feed IDs and Examples boxes
  • Verify this actually resolves the original formatting issue reported on the production site
  • Compare the PR diff to the base branch to confirm there are meaningful changes (may be whitespace-only or no changes)
  • Check both Core APIs and Pro API links work correctly in the preview

@devin-ai-integration @jayantk
Fix API Reference formatting to match other boxes
4d184f1 
- Consolidated multi-line h3 and p tags to single lines
- Consolidated multi-line anchor tags to single lines
- Made formatting consistent with Price Feed IDs and Examples boxes

Co-Authored-By: Jayant <jayantkrishnamurthy@gmail.com>
@devin-ai-integration
Copy link
Contributor Author

Prompt hidden (unlisted session)

@devin-ai-integration
Copy link
Contributor Author

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment and CI monitoring

@vercel
Copy link

vercel bot commented Oct 22, 2025 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Preview Comments Updated (UTC)
docs Ready Ready Preview Comment Oct 22, 2025 3:13pm
documentation Error Error Oct 22, 2025 3:13pm

@aditya520
Copy link
Member

aditya520 commented Oct 22, 2025 •
edited
Loading

@devin Can you run pre-commit on all files?

@devin-ai-integration @jayantk
Run pre-commit prettier formatting
7d21882 
Co-Authored-By: Jayant <jayantkrishnamurthy@gmail.com>
@aditya520 aditya520 enabled auto-merge (rebase) October 22, 2025 15:12
@aditya520 aditya520 disabled auto-merge October 22, 2025 15:31
@aditya520 aditya520 enabled auto-merge (rebase) October 22, 2025 15:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@aditya520 aditya520 aditya520 approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@aditya520