Skip to content

docs: add dynamic links to PRs for review docs - #284

Open
glasnt wants to merge 3 commits into
mainfrom
pr-link
Open

glasnt wants to merge 3 commits into
mainfrom
pr-link

Conversation

@glasnt

@glasnt glasnt commented Oct 25, 2026

Copy link
Copy Markdown
Member

Uses config variables for customised links for any repo that embeds this shared content

beeware/beeware#618

PR Checklist:

  • I will abide by the BeeWare Code of Conduct
  • I have read and have followed the CONTRIBUTING.md file
  • This PR was generated or assisted using an AI tool

Uses config variables for customised links for any repo that embeds this
shared content

@freakboy3742 freakboy3742 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

The extra content looks great; the only question I've got is about the location of the content. It's currently on the "how" page; but it seems to be more of a "what" question (which is born out by both the heading, and the shortlink added in beeware/beeware.github.io#839. Would it make sense to move this paragraph to the what/pr_review page?

Related to that - was the intention to update this content to include an explicit reference to the short links once they're available (which they now are)?

@glasnt

glasnt commented Nov 1, 2026

Copy link
Copy Markdown
Member Author

I've moved the updates to the what page, which is also the b/review-guide shortlink.

Only one shortlink is valid in this context, so I've replaced that. We could add a shortlink for "review-passing" or similar, but the context-aware link can't shortened, but it should still work in the what page (presuming how is inset of what, it should work across repo includes)

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