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

docs: add home page #573

Merged
merged 6 commits into from
Aug 13, 2021
Merged

docs: add home page #573

merged 6 commits into from
Aug 13, 2021

Conversation

ofekashery
Copy link
Member

Checklist

  • Fix linting errors
  • Tests have been added / updated (or snapshots)

Change information

Home page with light theme

Home page with dark theme

@codecov
Copy link

codecov bot commented Jun 26, 2021

Codecov Report

Merging #573 (1988d2a) into rc (4675e22) will decrease coverage by 0.28%.
The diff coverage is n/a.

❗ Current head 1988d2a differs from pull request most recent head 298debc. Consider uploading reports for the commit 298debc to get more accurate results
Impacted file tree graph

@@            Coverage Diff             @@
##               rc     #573      +/-   ##
==========================================
- Coverage   99.82%   99.54%   -0.29%     
==========================================
  Files         194      190       -4     
  Lines        2931     2872      -59     
  Branches      664      650      -14     
==========================================
- Hits         2926     2859      -67     
- Misses          5       13       +8     
Impacted Files Coverage Δ
components/modal/modal-wrapper.tsx 69.23% <0.00%> (-30.77%) ⬇️
components/drawer/drawer.tsx
components/drawer/index.ts
components/drawer/drawer-wrapper.tsx
components/drawer/helper.ts

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 4675e22...298debc. Read the comment docs.

@ofekashery ofekashery added the type: documentation Improvements or additions to documentation label Jun 26, 2021
@ofekashery ofekashery requested a review from unix June 26, 2021 19:31
lib/components/menu/menu-links.tsx Outdated Show resolved Hide resolved
lib/components/menu/menu-links.tsx Outdated Show resolved Hide resolved
py={0}
label={isChinese ? '主页' : 'Home'}
value=""
/>
Copy link
Member

Choose a reason for hiding this comment

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

We can hide the Tabs on this page?

Copy link
Member Author

Choose a reason for hiding this comment

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

I don't think there is a reason, it is much simpler to navigate like this.

Copy link
Member

Choose a reason for hiding this comment

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

If we don't hide the Tabs, the Home page is a bit redundant.
Home is not a placeholder or a skeleton, I don't need to stay on the home page, because there is no point.
Make Home a brand home page and ask users to interact with it, which will enhance the value of the page and reduce the distraction of Tabs from the brand page presentation.

A simple comparison:

  • Every time I open the home page I need to stay on the Home page, but there is nothing on this page and I still click on the tabs to go to the page I need, which only annoys me.
  • The home page is a clean display of the brand without the distraction of Tabs or Footer, I can choose a category to browse from the brand page, which makes me feel that home is meaningful, it's like the cover of a book rather than a title page that forces people to browse.

Copy link
Member Author

Choose a reason for hiding this comment

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

The home screen is indeed a brand page, which encourages you to use Geist. The primary button on the page is the Documentation button.
While the cards were designed to show the Geist's features, I can see how those can be clickable. But in terms of UX, I don't think it's worth hiding the menu, users know it and it appears on all other pages.
I suggest using both, what do you think? @unix

pages/en-us/index.tsx Show resolved Hide resolved
pages/en-us/index.tsx Outdated Show resolved Hide resolved
pages/zh-cn/index.tsx Show resolved Hide resolved
pages/zh-cn/index.tsx Outdated Show resolved Hide resolved
pages/zh-cn/index.tsx Outdated Show resolved Hide resolved
lib/components/menu/menu-links.tsx Show resolved Hide resolved
lib/components/menu/menu-links.tsx Outdated Show resolved Hide resolved
lib/components/menu/menu-links.tsx Outdated Show resolved Hide resolved
py={0}
label={isChinese ? '主页' : 'Home'}
value=""
/>
Copy link
Member

Choose a reason for hiding this comment

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

If we don't hide the Tabs, the Home page is a bit redundant.
Home is not a placeholder or a skeleton, I don't need to stay on the home page, because there is no point.
Make Home a brand home page and ask users to interact with it, which will enhance the value of the page and reduce the distraction of Tabs from the brand page presentation.

A simple comparison:

  • Every time I open the home page I need to stay on the Home page, but there is nothing on this page and I still click on the tabs to go to the page I need, which only annoys me.
  • The home page is a clean display of the brand without the distraction of Tabs or Footer, I can choose a category to browse from the brand page, which makes me feel that home is meaningful, it's like the cover of a book rather than a title page that forces people to browse.

pages/en-us/index.tsx Outdated Show resolved Hide resolved
@unix unix merged commit d59c400 into geist-org:rc Aug 13, 2021
unix added a commit that referenced this pull request Aug 13, 2021
* docs: add home page

* docs(homepage): apply suggestions from code review

* docs(homepage): make cards clickable

Co-authored-by: witt <unix.bio@gmail.com>
unix added a commit that referenced this pull request Aug 13, 2021
* feat(slider): add option to hide slider value (#494)

* feat(slider): hideValue prop added

* test(slider): test added for hideValue prop

docs(slider): add hideValue prop

docs(slider): add hideValue prop for cn docs

feat(slider): ensure the dot stays round when no content

test(slider): update snapshots

* feat(loading): apply width & height props (#500)

* feat(loading): apply width & height props

* test(loading): test case added & updating snapshots

* fix(loading): add a string type for size prop

test(loading): update test case & snapshots

* feat(loading): support custom the ratio of spaces

* docs(loading): append size and spaceRatio

test(loading): update snapshots

Co-authored-by: unix <unix.bio@gmail.com>

* chore(deps): update styled-jsx to ^3.3.1 (#520)

* chore(deps): update styled-jsx to ^3.3.1

update styled-jsx to ^3.3.1 to allow compatiblity with react@^17

* fix(modules): fix 695-issue to compatible with React 17

* docs: fix module error caused by styled-jsx update

Co-authored-by: unix <unix.bio@gmail.com>

* chore: release v2.2.0-rc.0

* fix(modal): disable backdrop even if actions missing (#532)

* fix: upgrade to be compatible with React-17's event system (#533)

* feat: useKeyboard hooks (#541)

* feat(keyboard): create keyboard hooks

* feat(usekeyboard): redesign event handler to match keyboard events from browser

\

* test(usekeyboard): add testcase

* docs(usekeyboard): create new hooks document

* chore: release v2.2.0-rc.1

* feat(auto-complete): add forwardRef for input element (#542)

* feat(auto-complete): add forwardRef for input element

* test(auto-complete): add testcase to ensure ref is available

* docs(auto-complete): append props for ref

* chore: release v2.2.0-rc.2

* fix(auto-complete): fix size of loading icon (#546)

* chore: release v2.2.0-rc.3

* fix(auto-complete): hide shadow when no content (#547)

* chore: release v2.2.0-rc.4

* feat: add status prop in checkbox, radio, select, slider and toggle (#530)

* feat: added status prop to set color by states

test: check status success, warning and error

* docs: added playground example and API reference

fix: replaced ´_´ as it's not recommended to use

fix: removed redundant return

refactor: renamed prop from status to type

test: update test with the renamed prop

* docs: update prop references from status to type

fix: status prop not updated to type

fix: missing return

* fix(select): set icons and hover state to follow the theme

* test(slider): update snapshots

* chore: always use relative paths when import types

Co-authored-by: unix <unix.bio@gmail.com>

* feat(auto-complete): add props for popup container (#558)

* feat(auto-complete): add props for popup container

* docs(auto-complete): add attribute for popup container

* chore: release v2.2.0-rc.5

* fix: fix path error under esm

* chore: release v2.2.0-rc.6

* feat(scaleable): add scaleable props to each component (#531)

* feat(scaleable): add scaleable props to each component

* chore(scaleable): update the exported type

* feat: apply scaleable to components

chore: remove with-default

test: improve testcase for scaleable

chore: resolve test warning

ci: upgrade nodejs to latest lts

docs: fix type error in document site

* docs: update documents to be compatible with scaleable

chore: fix build errors

* chore: remove all size-related attributes

docs: improve guide document

* docs: add scaleable documentation

test: update snapshots

chore: remove unused

* feat: add scaleable to grid components

* docs: improve docs

* test: update snapshots

* fix(grid): fix basic component props

* feat: export all types related to components (#562)

* feat: export all types related to components

fix(tooltip): fix the vertical offset of the arrow

* refactor: optimize events of all popup related components

* test: append testcases for popup base component

* test: add testcase for visible events

* test: update snapshots

* fix(bundle): fix modules missing in yarn berry (#563)

* chore: add peer dependencies

* fix(bundle): fix modules missing in yarn berry

* chore: upgrade configs for jest 27

* chore(examples): upgrade next examples for scaleable (#564)

* chore: release v2.2.0-rc.7

* feat(rating): a new component rating indicator (#543)

* chore(deps): bump lodash from 4.17.20 to 4.17.21 (#537)

Bumps [lodash](https://github.com/lodash/lodash) from 4.17.20 to 4.17.21.
- [Release notes](https://github.com/lodash/lodash/releases)
- [Commits](lodash/lodash@4.17.20...4.17.21)

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* (feature) rating state working and islocked working

* (feature) custom emojis for the ratings added

* refactor(rating): migrate component to scaleable

* feat(rating): use inline icon component

test(rating): update testcase

* docs(rating): add document for zh-cn

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: unix <unix.bio@gmail.com>

* refactor(table): redesign interfaces to improve the experience in TypeScript (#569)

* refactor(table): redesign interfaces to improve the experience in TypeScript

* docs: upgrade to new type exports

* style: fix lint warnings

* docs: fix sidebar text-transform (#570)

* docs: improve the copywriting content of the document (#571)

* docs: export individual style types for each component

* docs: improve the copywriting content of the document

* docs: optimize the document site experience on mobile devices

* chore: release v2.2.0-rc.8

* feat(modal): responds to keyboard events when modal is displayed (#574)

* docs: redesign mobile navigation (#576)

* docs: redesign mobile navigation

* docs: fix subheading active color

* fix(avatar): fix margin on first child (#578)

Co-authored-by: witt <unix.bio@gmail.com>

* feat(select): imporve the focus events to export simulated ref (#579)

* feat(select): imporve the focus events to export simulated ref

* test: improve testcase and fix warnings

* docs(select): add label and divider to props docs

* fix: rename hymlType to htmlType (#599)

* feat(drawer): create component (#575)

* feat(drawer): create component

* feat(drawer): refinement of drawer component

* test: update tool chain for jest

* test: simplify events case for jest

* docs(drawer): add playground

* docs(drawer): add api docs

* docs: add home page (#573)

* docs: add home page

* docs(homepage): apply suggestions from code review

* docs(homepage): make cards clickable

Co-authored-by: witt <unix.bio@gmail.com>

* test: update snapshots for scaleable

* chore: update lock file

* chore: upgrade styled-jsx

* test: update snapshots for styled-jsx

Co-authored-by: Deepankar <deep14bhade@gmail.com>
Co-authored-by: Deepankar <statisticsaffinity@gmail.com>
Co-authored-by: Florian Levis <levis.florian@gmail.com>
Co-authored-by: gepd <guillermoepd@hotmail.com>
Co-authored-by: Nils J <nils.jorek@gmx.de>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Ofek Ashery <ofek.ashery@gmail.com>
Co-authored-by: Sanna Jammeh <50969683+sannajammeh@users.noreply.github.com>
@ofekashery ofekashery deleted the homepage branch February 11, 2022 22:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants