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

Quantum Website #156

Open
simoneb opened this issue Nov 14, 2023 · 3 comments
Open

Quantum Website #156

simoneb opened this issue Nov 14, 2023 · 3 comments

Comments

@simoneb
Copy link
Member

simoneb commented Nov 14, 2023

Let's create a website for Quantum. The storybook website doesn't look like a real website at the moment, so I would propose that either we build a real one, or we change the storybook one enough to make it looks like one.

Existing examples of websites for design systems are:

I don't have strong opinions about the tech, ideally I would not want to throw away Storybook, but I'm not sure if it is flexible enough to tweak it to look like a real website. On the other hand, if we use a tool like Docusaurus, which is more suitable for building websites, I'm not sure whether it's possible to integrate storybook or reproduce its features.

Earlier work we've done on this is:

@marceloFerreira90
Copy link
Contributor

Linked to : #274

@marceloFerreira90
Copy link
Contributor

Depends on new branding.

@nickzafiropulos
Copy link

nickzafiropulos commented Jan 9, 2024

Design update -

I have created some designs for the documentation site, based on previous work we have done, implementing Docusaurus (Optic and Initium websites).

Homepage - https://www.figma.com/file/vIqNb3g23SIGRiYUUDf5yE/Quantum-Documentation-site?type=design&node-id=1-49&mode=design

Note - Component illustrations to be completed. Colour will update with brand changes (issue to be completed)

Content pages - https://www.figma.com/file/vIqNb3g23SIGRiYUUDf5yE/Quantum-Documentation-site?type=design&node-id=4-1311&mode=design

  • Get started: This would contain developer focused content on how to set up Quantum to use on your projects
  • Component, Button: This is an example of a component page - the format is based around two main tabs; Overview (content written by designers) and React (Embedded component and dev focused detail)

Component pages include a sub nav (right) which allows us to jump to headings within the content. This allows us to be flexible with the type of content on each component. Sometimes there will be more, sometimes less, depending on the component. It also allows us to add content incrementally depending on our resource available.

The structure is closely aligned with GitHub's Primer documentation site. It fits well with our DS.

Adding documentation content for all the components will be an ongoing thing, probably taking a fair bit of time for a designer to work on, and we will need to get through the component backlog first, as the documentation site itself uses Quantum components.

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

No branches or pull requests

3 participants