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.

Sign up for GitHub

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

Jump to bottom

chore(docs): restructured Skin docs site and made it more mobile friendly #2520

Merged
merged 4 commits into from
Jan 10, 2025
Merged

chore(docs): restructured Skin docs site and made it more mobile friendly #2520

merged 4 commits into from
Jan 10, 2025

Conversation

ArtBlue
Copy link
Contributor

@ArtBlue ArtBlue commented Dec 31, 2024 •
edited
Loading

Fixes #2411

  • This PR contains CSS changes
  • This PR does not contain CSS changes

Description

IMPORTANT! Make sure you review with @marko/run version of 0.4.5. Future versions after this one have some issues and the app fails to start up.

  • Restructured the Skin site
  • Added hamburger menu for small screens
  • Moved a significant number of files around
  • Made the site more small screen friendly

Notes

  • This is the initial set of changes. More adjustments are needed to get things hooked up and working efficiently.
  • Most of the diffs in this PR are from moving the modules from component-based (route-less) loading to their individual css component routes.
  • As planned, I exposed the guide pages to users to be more easily findable.
  • I had to separate the guide pages with instructional content from the examples that require blank pages. The reason they are not nested is because the example pages need to have a blank layout and should not be inheriting the main site template.
  • I believe we can now remove /src/modules/, but I haven't done so yet.

Things TBD and Known Issues

  • The archive pages are no longer available (404) and I don't know why. We'll need to figure out what structural change caused it and get the page back.
  • Move the scripts from main.js into the individual pages scripts to their own module/page files.
  • Move the styles from routes/_index/+layout.style.scss into styles specific to each region (header, footer, etc.) should go into the specific components.
  • Move out the styles from breakpoints.scss into the individual sections/components.
  • Add/Create +meta.json files for all components with a minimum of page title and meta description.
  • Add/Create breadcrumbs
  • When we have a new Skin logo, create icons for various platforms and update the <head> with the meta tags.

Checklist

  • I verify the build is in a non-broken state
  • I verify all changes are within scope of the linked issue
  • I regenerated all CSS files under dist folder
  • I tested the UI in all supported browsers
  • I did a visual regression check of the components impacted by doing a Percy build and approved the build
  • I tested the UI in dark mode and RTL mode
  • I added/updated/removed Storybook coverage as appropriate

@ArtBlue ArtBlue self-assigned this Dec 31, 2024
@changeset-bot changeset-bot
Copy link

changeset-bot bot commented Dec 31, 2024 •
edited
Loading

⚠️ No Changeset found

Latest commit: 26e856a

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

agliga
agliga approved these changes Jan 9, 2025
View reviewed changes
Copy link
Contributor

@agliga agliga left a comment •
edited
Loading

Choose a reason for hiding this comment

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

I am approving for now. I don't see any major issues. We can get the search and any other changes in follow up PRs.
It would be good to merge this soon so we can work on top of these changes.

Also the marko run works now. I upgraded the branch to the latest version which fixed the issue we had (problem was that marko run was reading components directory as a marko component and causing problems!)

@ArtBlue
Copy link
Contributor Author

ArtBlue commented Jan 10, 2025

I am approving for now. I don't see any major issues. We can get the search and any other changes in follow up PRs. It would be good to merge this soon so we can work on top of these changes.

Also the marko run works now. I upgraded the branch to the latest version which fixed the issue we had (problem was that marko run was reading components directory as a marko component and causing problems!)

Yea, that's what I was hoping we would do from the beginning. Sounds good. Thanks!

@ArtBlue ArtBlue marked this pull request as ready for review January 10, 2025 17:07
@ArtBlue ArtBlue merged commit 530308f into 19.0.0 Jan 10, 2025
@ArtBlue ArtBlue deleted the 2411-docs-site-rebuild branch January 10, 2025 17:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@agliga agliga agliga approved these changes

@ianmcburnie ianmcburnie Awaiting requested review from ianmcburnie

@saiponnada saiponnada Awaiting requested review from saiponnada

@LuLaValva LuLaValva Awaiting requested review from LuLaValva

@WinkeeFace WinkeeFace Awaiting requested review from WinkeeFace

Assignees

@ArtBlue ArtBlue

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@ArtBlue @agliga