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

Common Settings Page #3177

Merged
merged 21 commits into from
Oct 4, 2023
Merged

Common Settings Page #3177

merged 21 commits into from
Oct 4, 2023

Conversation

hgluka
Copy link
Contributor

@hgluka hgluka commented Sep 19, 2023

Description

This PR is for the new layout of the Common Settings page, per #3174.
It's still in the early stages. I'm still working on the general structure of the document.

Resolves #3174.

Discussion

As @aartaka mentioned in #3174, we could make the whole thing a form with a "Save" button at the end.

Checklist:

Everything in this checklist is required for each PR. Please do not approve a PR that does not have all of these items.

  • Git hygiene:
    • I have pulled from master before submitting this PR
    • There are no merge conflicts.
  • I've added the new dependencies as:
    • ASDF dependencies,
    • Git submodules,
      cd /path/to/nyxt/checkout
      git submodule add https://gitlab.common-lisp.net/nyxt/py-configparser _build/py-configparser
    • and Guix dependencies.
  • My code follows the style guidelines for Common Lisp code. See:
  • I have performed a self-review of my own code.
  • My code has been reviewed by at least one peer. (The peer review to approve a PR counts. The reviewer must download and test the code.)
  • Documentation:
    • All my code has docstrings and :documentations written in the aforementioned style. (It's OK to skip the docstring for really trivial parts.)
    • I have updated the existing documentation to match my changes.
    • I have commented my code in hard-to-understand areas.
    • I have updated the changelog.lisp with my changes if it's anything user-facing (new features, important bug fix, compatibility breakage).
      • Changelog update should be a separate commit.
    • I have added a migration.lisp entry for all compatibility-breaking changes.
    • (If this changes something about the features showcased on Nyxt website) I have these changes described in the new/existing article at Nyxt website or will notify one of maintainters to do so.
  • Compilation and tests:
    • My changes generate no new warnings.
    • I have added tests that prove my fix is effective or that my feature works. (If possible.)
    • I ran the tests locally ((asdf:test-system :nyxt) and (asdf:test-system :nyxt/gi-gtk)) and they pass.

@aadcg
Copy link
Member

aadcg commented Sep 19, 2023

As @aartaka mentioned in #3174, we could make the whole thing a form with a "Save" button at the end.

Was it agreed upon though? I don't think that qualifies as user-friendly by any means. As of today, a change in a parameter is registered immediately. Such a change would be a regression in my opinion. CC @jmercouris.

@lansingthomas
Copy link
Contributor

Additional spec for the New Buffer Settings section:

Colors for the display area:

background:
(background-) #ECECEC in light theme, and #333333 in dark theme

Border and text:

  • corner rounding on the whole object (~3px)
  • the border and text are the same color in both light and dark theme.
    • light #909090
    • dark #A55D2F
screenshot-pow-bang 2023-09-19 at 2 57 32 PM

@jmercouris
Copy link
Member

jmercouris commented Sep 19, 2023

I agree, it would probably be a regression, however I leave the last word to Thomas.

Edit: The oracle has spoken, the save button shall be avoided.

@hgluka
Copy link
Contributor Author

hgluka commented Sep 26, 2023

I got configure-slot to cooperate! Now we can give it multiple sources, with or without marks, "postprocess" the result if necessary, etc.
I think that's finally all the different ways of interacting with settings done. Now I just need to add the second column with the documentation and make the whole page use the side-tab layout that @lansingthomas proposed. Should be done soon!

Screenshot from 2023-09-26 13-24-00

@lansingthomas
Copy link
Contributor

Now I just need to add the second column with the documentation and make the whole page use the side-tab layout

Yes! I am looking forward to seeing it.

@hgluka
Copy link
Contributor Author

hgluka commented Sep 28, 2023

Side tab layout is done!
Here it is:

Screenshot from 2023-09-28 15-19-07

@lansingthomas
Copy link
Contributor

Niiiice

@hgluka
Copy link
Contributor Author

hgluka commented Sep 29, 2023

I think this is ready for review. There might be a bit more cleaning up to do, but everything works and it looks (close to) how @lansingthomas imagined it, I hope! Let me know if I missed anything.

CC @jmercouris

@jmercouris
Copy link
Member

Will review, thank you!

Copy link
Contributor

@lansingthomas lansingthomas left a comment

Choose a reason for hiding this comment

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

The headings should be title case.
Same with line 127 -- the "Buffer Settings" side panel text

@jmercouris
Copy link
Member

Looks very close to me Luka. I may tweak some CSS and merge it, pending your permission, and a final review with Thomas on Tuesday, does that sound OK?

@hgluka
Copy link
Contributor Author

hgluka commented Oct 2, 2023

@jmercouris Sure, go ahead! I didn't really think through the CSS, I just cobbled it together so that everything looks okay.

@jmercouris jmercouris merged commit 8edcc49 into master Oct 4, 2023
@jmercouris jmercouris deleted the settings-frontend branch October 4, 2023 01:33
@jmercouris
Copy link
Member

Don't tell me that I did this merge wrong @aadcg I swear I did everything correct! :-O

@jmercouris
Copy link
Member

Thanks Luka :-)

@aartaka
Copy link
Contributor

aartaka commented Oct 4, 2023 via email

@jmercouris
Copy link
Member

i see, thanks for the clarification

@aadcg
Copy link
Member

aadcg commented Oct 4, 2023

@jmercouris it was merged properly. Thanks.

@aadcg
Copy link
Member

aadcg commented Oct 9, 2023

What failed was the changelog entry. CC @hgluka @jmercouris.

@hgluka
Copy link
Contributor Author

hgluka commented Oct 9, 2023

@aadcg Should I add it as a commit directly to master?

@aadcg
Copy link
Member

aadcg commented Oct 9, 2023

A serious review wasn't carried out in this PR (see #3209). This is not acceptable. Features can't be broken from the start.

@aadcg
Copy link
Member

aadcg commented Oct 9, 2023

@hgluka No. I'll do it in the release process. Thanks.

@hgluka hgluka mentioned this pull request Oct 9, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

Common Settings Page Layout
5 participants