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

Update Docs for z-index & drop-shadow for better clarity #813

Closed
1 task
nucleogenesis opened this issue Oct 29, 2024 · 8 comments
Closed
1 task

Update Docs for z-index & drop-shadow for better clarity #813

nucleogenesis opened this issue Oct 29, 2024 · 8 comments
Assignees
Labels
category: docs content Design patterns and component usage good first issue Self-contained, straightforward, low-complexity help wanted Open source contributors welcome

Comments

@nucleogenesis
Copy link
Member

nucleogenesis commented Oct 29, 2024

🌱 Are you new to the codebase? Welcome! Please see the contributing guidelines.

Desired behavior

In discussion re: learningequality/kolibri#12630 we discussed that the (pr 723 Netlify Deploy version) Elevation & Shadow docs is a bit ambiguous and could use a bit of reworking. (Related Notion doc).

This follows up from #723 which added docs for drop-shadows

  • The Google Material Design elevation image is not relevant to our approach to drop-shadows, so it should be moved down to the "z-index" section where it is more relevant.

Acceptance criteria

  • The dropshadow image is displayed under the z-index section.

(Optional) The Value Add

Clearer guidance reduces the potential for confusion while referring to the drop-shadow docs.

@nucleogenesis nucleogenesis added the category: docs content Design patterns and component usage label Oct 29, 2024
@nucleogenesis nucleogenesis changed the title [Title]: Brief description Update Docs for z-index & drop-shadow for better clarity Oct 29, 2024
@AlexVelezLl AlexVelezLl added good first issue Self-contained, straightforward, low-complexity help wanted Open source contributors welcome labels Nov 8, 2024
@RONAK-AI647
Copy link
Contributor

Hey @AlexVelezLl Assign it to me please!!!

@AlexVelezLl
Copy link
Member

For sure @RONAK-AI647! Thanks for volunteering!

@RONAK-AI647
Copy link
Contributor

RONAK-AI647 commented Nov 8, 2024

Hey @AlexVelezLl ,it is mentioned 'Google Material Design elevation image is not relevant to our approach to drop-shadows'
I suppose the image under "elevation and shadows" is more relevant .

@AlexVelezLl
Copy link
Member

Hey @RONAK-AI647! Yes, its the same image, but it should be shown in the Z-index section where is more relevant

@RONAK-AI647
Copy link
Contributor

RONAK-AI647 commented Nov 8, 2024

@AlexVelezLl ,I am bit confused ,few minutes earlier the pic was this
Image

and now it shows this

Image

Another thing ,if I just move it to z-index, the dropshadows section would look empty ,as the pic is showcased in an example with a logic code.

@AlexVelezLl
Copy link
Member

Oh I think you are checking the wrong website 😅. In the issue is described this docs page: https://deploy-preview-723--kolibri-design-system.netlify.app/styling/#elevation which is from our develop branch. There you will find this image which is the one the issue talks about:

Image

@RONAK-AI647
Copy link
Contributor

I was doing the same thing ,but due to misconception ,I stepped back....anyways thankyou @AlexVelezLl I have raised the PR.

@MisRob
Copy link
Member

MisRob commented Dec 2, 2024

Closed by #819

@MisRob MisRob closed this as completed Dec 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
category: docs content Design patterns and component usage good first issue Self-contained, straightforward, low-complexity help wanted Open source contributors welcome
Projects
None yet
Development

No branches or pull requests

4 participants