Skip to content

Conversation

@hellovai
Copy link
Contributor

Pull Request Template

Thanks for taking the time to fill out this pull request!

Issue Reference

Please link to any related issues

  • This PR fixes/closes #[issue number]

Changes

Please describe the changes proposed in this pull request

Adds a highly visible, permanent banner to the top of all BEP documentation pages, displaying the current Git branch name. This is achieved by:

  • Creating a custom main.html override to render the banner in the MkDocs Material announce block.
  • Updating mkdocs.yml to reference the new overrides directory.
  • Implementing a bep_hooks.py function to dynamically fetch the Git branch name and inject it into the MkDocs template context.

Testing

Please describe how you tested these changes

  • Unit tests added/updated
  • Manual testing performed
  • Tested in local build environment

Screenshots

If applicable, add screenshots to help explain your changes

[Add screenshots here...]

PR Checklist

Please ensure you've completed these items

  • I have read and followed the contributing guidelines
  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings

Additional Notes

Add any other context about the PR here

The banner features a prominent purple background and a branch icon to ensure high visibility, fulfilling the requirement for a "permabanner" that clearly indicates the current branch.


Slack Thread

Open in Cursor Open in Web

@cursor
Copy link

cursor bot commented Dec 18, 2025

Cursor Agent can help with this pull request. Just @cursor in comments and I'll start working on changes in this branch.
Learn more about Cursor Agents

@vercel
Copy link

vercel bot commented Dec 18, 2025

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

Project Deployment Review Updated (UTC)
promptfiddle Ready Ready Preview, Comment Dec 18, 2025 1:49am

@github-actions
Copy link

github-actions bot commented Dec 18, 2025

Latest build completeView logs

@github-actions
Copy link

🐑 BEPs Preview Ready

Preview URL: https://dj7ggjkp4tlhz.cloudfront.net/cursor-cursor-beps-permabanner-8153/

Commit: 296123cfb2187b72e0067cf6cbe7a2c7da783234Workflow run

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.

3 participants