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

Developer Portal #79

Merged
merged 21 commits into from
Nov 19, 2024
Merged

Developer Portal #79

merged 21 commits into from
Nov 19, 2024

Conversation

wilwade
Copy link
Contributor

@wilwade wilwade commented Oct 24, 2024

Feature Branch for the Developer Portal

Closes: #93

wilwade and others added 16 commits October 25, 2024 10:36
Problem
=======
Theme adjustments for MD book to reflect current mocks

Closes #81
- Adding initial new content
- Renaming the Lightpaper to Core
- Support for buttons in markdown

Closes #88
Closes #89
Closes #90
Closes #91
Problem
=======

Matching the header to the design

Closes #82

Solution
========

- Static header added
- JS to manage header open/closed state
- Styles

with @claireolmstead 
---------

Co-authored-by: Claire Olmstead <[email protected]>
Needing to add buttons to the sidebar, this does it!

Closes #84 

Solution
========

- Note: These icons are the placeholder icons
- There is no way to get in and update the mdbook `toc` setup, so
instead we are just adding the icons via css.
- Assumption is that there will be a different dark mode, but that might
not be.
- Assumption is that there might be a different active/hover (or
`currentColor` use), but not doing that until we have final icons
- Changed the spacing a bit from the original mocks per a design
discussion
Problem
=======

Needed to do the footer, but had to change a good amount to make it
work.

Closes #83 

Solution
========

- Added a grid
- Moved the old menu icons to the left as a column
- Shifted around a few things for the grid.
- Kept the resize
- Kept the sidebar animation
- Kept the touch controls for mobile (swipe to get the sidebar)
- Added the footer
Problem
=======

It was hard to copy components into docs without re-writing all the
tailwind into custom css. This enables tailwind css for us!

Solution
========

- Added tailwind via npx command preprocessor
- Split up the other preprocessors for easier use
- Updated to the new footer using tailwind
- Reset rem to 100% as tailwind assumes that (and moved rem based things
to px).

Steps to Verify:
----------------
1. `npm i`
2. `mdbook serve`
Problem
=======

- Updating to the latest header design
- Small tweaks to other colors and the footer
- Fixed header margins and other tailwind collisions
Problem
=======

- Updates icons to the correct ones
- Adds page images (placeholders)

Co-authored-by: Patrick <[email protected]>
Problem
=======

Updating to the final Light and Dark illustrations

Closes #102
Problem
=======
Create a title image/number preprocessors for setting title icon and
number

Closes #85 

Solution
========
- [x] like svg-embed create a title-image preprocessor
- [x] it should take atleast a number and image as input and display
them as icons


Screenshots (optional):
-----------------------

![image](https://github.com/user-attachments/assets/cf230d7c-4361-4104-abd4-1d9e6d5918c7)


![image](https://github.com/user-attachments/assets/411fd85f-4ad5-4642-8155-70d0ec14be38)

---------

Co-authored-by: Wil Wade <[email protected]>
Problem
=======

Various small layout issues addressed (one of a few PRs for this sort of
stuff)

Closes #101
Closes #104 
Closes #86
Part of #87

Solution
========
- Fix font issue with Bold
- Remove dead styles
- Fix content margins to handle the left nav buttons with centering
- Fix the previous/next buttons on mobile
- Add a margin to the footer to fix the footer border from hitting the
side nav (slight design break)
Problem
=======

- Get the header updated to the correct colors and width patterns
- Update headers in light mode to be primary
- Move all text-navy to text-primary

Part of #87
Updated from the text and terms
Problem
=======

Various small fixes for the final tweaks of the docs

Closes: #87
@shannonwells
Copy link
Contributor

shannonwells commented Nov 18, 2024

This is very hard to read - needs moar whitespace, i.e. paragraph margins or to be converted to bullet points. And also, the title doesn't make sense, at least, I think it needs a colon after the title and it definitely needs a space before 'Providers'. Kerning still terrible... #keming

Screenshot 2024-11-18 at 2 10 46 PM

@shannonwells
Copy link
Contributor

shannonwells commented Nov 18, 2024

Spacing between what looks like should be paragraphs or bullet points seems to generally be a problem (desktop, FireFox):

Screenshot 2024-11-18 at 2 18 49 PM

@JoeCap08055
Copy link

This from the "Become a Provider" page doesn't look right; not sure what the design looks like but:

  • Heading doesn't read like a heading. A colon might help, but still reads weird to me.
  • Items beneath the heading need more separation, they run together & are hard to read. Should be bullets or offset somehow.

image

@JoeCap08055
Copy link

There doesn't appear to be any difference between nested levels of headings; ie "How You Can Become a Provider" is the main heading of a series of steps, but the steps have the same size & appearance as the parent.

image

@JoeCap08055
Copy link

It seems like when describing a multi-step process, the steps need to be delineated more, perhaps using a list format, or greater line spacing between steps. "Step 3" contains a multi-step process, but looks like just a big paragraph blob, easy to get lost in.

image

@JoeCap08055
Copy link

Clicking the same item in the sidebar multiple times gets the 404 page every other time

@JoeCap08055
Copy link

In general, more white space is needed to break up long content paragraphs.

@saraswatpuneet
Copy link
Contributor

Clicking on sidebar item more than once seems to append page url to base , keeping clicking and notice the address bar

@mattheworris
Copy link

In general, more white space is needed to break up long content paragraphs.

Agreed. I can make a list of pages with whitespace issues, if that's helpful.

Copy link

@claireolmstead claireolmstead left a comment

Choose a reason for hiding this comment

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

🚢

@wilwade wilwade merged commit 0fc40b2 into main Nov 19, 2024
3 checks passed
@wilwade wilwade deleted the developer-portal branch November 19, 2024 00:26
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.

Dev Docs Navigation and Content UI Foundations
6 participants