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

Add a front page to docs site for the v2 update to FAST Element #6971

Merged
merged 18 commits into from
Aug 1, 2024

Conversation

janechu
Copy link
Collaborator

@janechu janechu commented May 31, 2024

Pull Request

📖 Description

With the project re-alignment goals (#6955) this change seeks to highlight the use of @microsoft/fast-element as the package the documentation site is now focused on. This is similar to the previous frontpage for v1, however the content has been amended to get the user started on @microsoft/fast-element and states the updated project goals.

Screenshot_15-7-2024_115919_localhost

✅ Checklist

General

  • I have included a change request file using $ yarn change
  • I have added tests for my changes.
  • I have tested my changes.
  • I have updated the project documentation to reflect my changes.
  • I have read the CONTRIBUTING documentation and followed the standards for this project.

@janechu janechu self-assigned this May 31, 2024
Copy link
Collaborator

@radium-v radium-v left a comment

Choose a reason for hiding this comment

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

On small screens, the content overflows and requires horizontal scrolling to see all content. The content should wrap within the max width of the viewport. One exception are the code blocks, which should min-max their container widths and horizontally scroll their inner contents if there's not enough space.

iPhone 12 Pro, panned left
localhost_3000_(iPhone 12 Pro)

iPhone 12 Pro, panned right
localhost_3000_(iPhone 12 Pro) (1)

sites/website/src/pages/index.jsx Outdated Show resolved Hide resolved
@janechu janechu force-pushed the users/janechu/add-frontpage-to-docs branch from c873824 to fb344c7 Compare May 31, 2024 18:49
@janechu
Copy link
Collaborator Author

janechu commented May 31, 2024

@radium-v thanks! Please take another look, should be working better now without the overflow issues.

@janechu janechu force-pushed the users/janechu/add-frontpage-to-docs branch from e54f6f5 to 46247ec Compare June 18, 2024 17:14
@janechu janechu force-pushed the users/janechu/add-frontpage-to-docs branch from e58c5b3 to 1e404b4 Compare July 2, 2024 19:08
@janechu janechu force-pushed the users/janechu/add-frontpage-to-docs branch from 286210e to a07d431 Compare July 2, 2024 20:16
@MrHBS
Copy link

MrHBS commented Jul 15, 2024

Picture says “className HelloWorld…”. Is that correct?

@janechu
Copy link
Collaborator Author

janechu commented Jul 15, 2024

Picture says “className HelloWorld…”. Is that correct?

Fixed, great catch!

@janechu janechu merged commit b4b6813 into master Aug 1, 2024
7 checks passed
@janechu janechu deleted the users/janechu/add-frontpage-to-docs branch August 1, 2024 20:58
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