docs: A number of UI changes for Docusaurus #1366

mmulji-ic · 2023-10-17T10:11:54Z

Description

Updates the Docusarus theme with the following items:

Updates the copyright message
Fixes the footer, making the text visible
Fixes the footer Cosmos image link
Updates the Next/Prev card tags so that they are more easily visible
Adds the Hub icon to the theme
Adds a light mode

Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

included the correct docs: prefix in the PR title
targeted the correct branch (see PR Targeting)
provided a link to the relevant issue or specification
reviewed "Files changed" and left comments if necessary
confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

I have...

Confirmed the correct docs: prefix in the PR title
Confirmed all author checklist items have been addressed
Confirmed that this PR only changes documentation
Reviewed content for consistency
Reviewed content for spelling and grammar
Tested instructions (if applicable)
Checked that the documentation website can be built and deployed successfully (run make build-docs)

p-offtermatt · 2023-10-17T12:41:28Z

Thanks, checked it out locally and afaict everything looks good

MSalopek

Not sure the deploy works. Did you make a test deploy?

docs/docusaurus.config.js

MSalopek · 2023-10-31T14:59:35Z

docs/src/css/custom.css

@@ -355,12 +359,13 @@ html {

  /* RELATED ARTICLES */
  &[data-theme="dark"] .pagination-nav > a {
-    @apply bg-fg border-stone-800;
+    @apply bg-fg;


Don't know why you added border?

Was aligning with the hub docs site.

actually removed, but reverting anyway for the time being

MSalopek · 2023-10-31T15:01:42Z

docs/src/css/custom.css

    }
    blockquote {
      @apply my-7;
    }
    a {
-      @apply underline;
-      /* color: var(--ifm-color-primary ); */
+      @apply no-underline hover:underline;


Since the color choice is poor, it will be impossible to figure out which part of the text is a link.
That's why it was underlined in the first place.

p-offtermatt · 2023-11-01T08:43:45Z

Checked back in on this and noticed that dark theme works pretty poorly with some things here,
particularly links and highlighting text.

highlighted text is not legible

links indistinguishable

compare these in light mode:

highlighted text is readable

Link clearly visible

Co-authored-by: MSalopek <[email protected]>

mmulji-ic · 2023-11-21T13:49:41Z

highlighted text is readable

Locally yes, also @p-offtermatt did I believe.

mmulji-ic · 2023-11-21T13:50:03Z

Checked back in on this and noticed that dark theme works pretty poorly with some things here, particularly links and highlighting text. highlighted text is not legible links indistinguishable

compare these in light mode: highlighted text is readable Link clearly visible

Light mode is the way to go.

p-offtermatt · 2023-11-30T12:32:25Z

Checked back in on this and noticed that dark theme works pretty poorly with some things here, particularly links and highlighting text. highlighted text is not legible links indistinguishable
compare these in light mode: highlighted text is readable Link clearly visible

Light mode is the way to go.

Could we still change it so that it works properly in dark mode? We should be able to take the settings that work from the sdk and just change links to be more distinguishable

mmulji-ic · 2023-12-04T16:06:42Z

Could we still change it so that it works properly in dark mode? We should be able to take the settings that work from the sdk and just change links to be more distinguishable

The changes from SDK version aren't that significant.

MSalopek · 2023-12-04T19:49:18Z

Checked back in on this and noticed that dark theme works pretty poorly with some things here, particularly links and highlighting text.

Resolved a69ff73

MSalopek

Added some small changes and fixed deps.

A number of minor ui changes

2f6137f

mmulji-ic requested a review from a team as a code owner October 17, 2023 10:11

p-offtermatt approved these changes Oct 17, 2023

View reviewed changes

mmulji-ic self-assigned this Oct 18, 2023

mmulji-ic added scope: docs Improvements or additions to documentation S: ImprovingThings Improving things: Customer requests, performance improvements, reliability and usability labels Oct 18, 2023

MSalopek requested changes Oct 31, 2023

View reviewed changes

mmulji-ic and others added 2 commits November 21, 2023 14:48

Update docs/docusaurus.config.js

ddea789

Co-authored-by: MSalopek <[email protected]>

Update docs/docusaurus.config.js

02ac862

Co-authored-by: MSalopek <[email protected]>

Reverted some changes based on review comments

7b7a5f8

MSalopek force-pushed the mmulji-ic/update-ics-docs-theme branch from 661d055 to 7b7a5f8 Compare December 4, 2023 17:59

MSalopek added 3 commits December 4, 2023 19:02

Merge branch 'main' into mmulji-ic/update-ics-docs-theme

d11057c

chore: add math formula deps

dde4bdf

fix: rm underline on title cards; update highlight bg and font color

a69ff73

MSalopek self-requested a review December 4, 2023 19:49

MSalopek approved these changes Dec 4, 2023

View reviewed changes

mmulji-ic and others added 4 commits December 5, 2023 11:43

Added missing acorns

fa902d7

docs: rm curly braces from ADR template

2a0e673

docs: fix warnings; fix errs; use min-h-screen for content

c0d0c28

Merge branch 'main' into mmulji-ic/update-ics-docs-theme

bae8cd8

github-actions bot added C:Docs Assigned automatically by the PR labeler C:ADR Assigned automatically by the PR labeler labels Dec 5, 2023

MSalopek enabled auto-merge December 5, 2023 15:49

MSalopek added this pull request to the merge queue Dec 5, 2023

Merged via the queue into main with commit 583d178 Dec 5, 2023
14 checks passed

MSalopek deleted the mmulji-ic/update-ics-docs-theme branch December 5, 2023 16:10

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: A number of UI changes for Docusaurus #1366

docs: A number of UI changes for Docusaurus #1366

mmulji-ic commented Oct 17, 2023 •

edited

Loading

p-offtermatt commented Oct 17, 2023

MSalopek left a comment

MSalopek Oct 31, 2023

mmulji-ic Oct 31, 2023

mmulji-ic Dec 4, 2023 •

edited

Loading

MSalopek Oct 31, 2023

mmulji-ic Dec 4, 2023

p-offtermatt commented Nov 1, 2023 •

edited

Loading

mmulji-ic commented Nov 21, 2023

mmulji-ic commented Nov 21, 2023

p-offtermatt commented Nov 30, 2023

mmulji-ic commented Dec 4, 2023

MSalopek commented Dec 4, 2023

MSalopek left a comment

docs: A number of UI changes for Docusaurus #1366

docs: A number of UI changes for Docusaurus #1366

Conversation

mmulji-ic commented Oct 17, 2023 • edited Loading

Description

Author Checklist

Reviewers Checklist

p-offtermatt commented Oct 17, 2023

MSalopek left a comment

Choose a reason for hiding this comment

MSalopek Oct 31, 2023

Choose a reason for hiding this comment

mmulji-ic Oct 31, 2023

Choose a reason for hiding this comment

mmulji-ic Dec 4, 2023 • edited Loading

Choose a reason for hiding this comment

MSalopek Oct 31, 2023

Choose a reason for hiding this comment

mmulji-ic Dec 4, 2023

Choose a reason for hiding this comment

p-offtermatt commented Nov 1, 2023 • edited Loading

mmulji-ic commented Nov 21, 2023

mmulji-ic commented Nov 21, 2023

p-offtermatt commented Nov 30, 2023

mmulji-ic commented Dec 4, 2023

MSalopek commented Dec 4, 2023

MSalopek left a comment

Choose a reason for hiding this comment

mmulji-ic commented Oct 17, 2023 •

edited

Loading

mmulji-ic Dec 4, 2023 •

edited

Loading

p-offtermatt commented Nov 1, 2023 •

edited

Loading