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.

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

Remove PR build notification and add info to Visual Diff #548

Closed
wants to merge 6 commits into from

Conversation

ericholscher
Copy link
Member

@ericholscher ericholscher commented Feb 19, 2025

This removes the PR build notification,
and includes some information in the Visual Diff UI with similar information.

I tested with a real version, but these would be PR #'s in normal usage:

Screenshot 2025-02-19 at 3 48 39 PM

Refs https://github.com/readthedocs/meta/issues/176

This removes the PR build notification,
and includes some information in the Visual Diff UI with similar information.
@ericholscher ericholscher requested review from humitos and a team as code owners February 19, 2025 23:49
@ericholscher
Copy link
Member Author

This is like a baby command palette :D

@agjohnson
Copy link
Contributor

It's odd to put unrelated links in this dropdown. The dropdown by default is going to have a selected value of Files changed in #markdoc, or have a filename after selecting. It's not going to be a discoverable place for users to find links to documentation/etc.

The more standard place to put this is under a kebab dropdown menu, or add the information circle icon with some sort of popup/etc.

I think what we talked about in the meeting was clickable element in the UI instead of repurposing the dropdown. I still like the default text addition to the dropdown, this adds enough context to drop the notification

@@ -197,10 +198,28 @@ export class FileTreeDiffElement extends LitElement {
${this.renderDocDiff()}
<select @change=${this.handleFileChange}>
<option value="" ?selected=${!hasCurrentFile} disabled>
Files changed
Files changed in #${this.config.versions.current.slug}
Copy link
Contributor

Choose a reason for hiding this comment

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

This needs to be conditional based on what the build is it seems. If it's a named branch, we should not use a # prefix, and if this is a pull request we want more descriptive PR #1234 instead here. This makes it immediately recognizable that this is a pull request build, without expanding this menu.

"notification",
)}"
>
Go to build log
Copy link
Contributor

Choose a reason for hiding this comment

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

The verb seems unneeded on these. These would also feel more natural under a dedicated menu, which would remove the need to explain that these are links that go to another page.

Suggested change
Go to build log
Build log

@humitos
Copy link
Member

humitos commented Feb 20, 2025

I agree with Anthony here. I would

  • add a small ℹ️ icon that links to the docs in the right
  • add a small #1234 with the PR number before the icon
  • don't add any unrelated links to the dropdown; only show the list of files
  • do not remove the current notification

I understand that's what we agreed in our meeting.

humitos added a commit that referenced this pull request Feb 20, 2025
This is what I understood we agreed on in our meetting.

* Closes #549
* Closes #548
@humitos
Copy link
Member

humitos commented Feb 20, 2025

I opened a PR with these changes in #551

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