PR8: feat: add design system documentation pages#1702
Open
anirudha wants to merge 2 commits intoopensearch-project:mainfrom
Open
PR8: feat: add design system documentation pages#1702anirudha wants to merge 2 commits intoopensearch-project:mainfrom
anirudha wants to merge 2 commits intoopensearch-project:mainfrom
Conversation
Add new Principles and Foundations documentation sections: - Principles: About OUI, Design Philosophy - Foundations: Color, Typography, Spacing & Layout, Elevation, Icons Infrastructure changes: - Route registrations for all new pages - Sidebar styling improvements (gradient border, hidden scrollbar, fade-out) - Scroll position preservation on navigation - Page body padding adjustment - scrollIntoView behavior fix Signed-off-by: Anirudha Jadhav <anirudha@nyu.edu> Signed-off-by: Anirudha (Ani) Jadhav <anirudha@nyu.edu>
anirudha
requested review from
AMoo-Miki,
Maosaic,
angle943,
ashwin-pc,
d-buckner,
ruanyl,
ruchidh and
virajsanghvi
as code owners
Signed-off-by: Anirudha (Ani) Jadhav <anirudha@nyu.edu>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add new Principles and Foundations documentation sections:
Infrastructure changes:
PR 8: Design System Docs (~20 files)
Scope: All new documentation pages and docs site infrastructure changes.
Files included:
src-docs/src/views/design_system_principles/(about_oui.tsx, design_philosophy.tsx)src-docs/src/views/design_system_foundations/(foundations_color.tsx, foundations_typography.tsx, foundations_spacing.tsx, foundations_elevation.tsx, foundations_icons.tsx)src-docs/src/routes.js(route registrations)src-docs/src/components/guide_components.scss(sidebar styling)src-docs/src/components/guide_page/guide_page_chrome.js(minor update)src-docs/src/views/app_view.js(minor update)i18ntokens.json(token updates from new pages)Note: Elevation docs (
src-docs/src/views/elevation/) are included in PR 4 since they're tightly coupled to the elevation feature. Pattern pages are included here.Testing:
yarn lint, docs site compiles (yarn start), visual verification of all new pages