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

Fix: Make <pre> element scrollable and remove unnecessary > code reference. #79

Closed
wants to merge 1 commit into from

Conversation

Nenepo
Copy link

@Nenepo Nenepo commented Oct 4, 2024

Fixes

Description

This pull request improves the behavior of the

 element within the documentation by introducing horizontal scrolling when content exceeds the viewport width. It ensures the page layout remains intact, without overflowing horizontally. Additionally, an unnecessary > code reference was removed since there was no  tag present in the HTML, making it redundant.

Technical details

  • The following styles were added to the

     tag to make it scrollable:
    pre {
    display: block;
    padding: 2em;
    overflow-x: auto;
    /* white-space: pre-wrap; */
    background: #ededed;
    }

  • The main tag also had overflow-x: hidden added to prevent horizontal overflow:
    main {
    overflow-x: hidden;
    }

  • The > code reference was removed from the HTML, as the tag was not in use.

Tests

  • Verify that the
     tag now properly scrolls when content is too long.
  • Verify that the main page does not scroll

Checklist

  • My pull request has a descriptive title (not a vague title like Update index.md).
  • My pull request targets the default branch of the repository (main or master).
  • My commit messages follow best practices.
  • My code follows the established code style of the repository.
  • I added or updated tests for the changes I made (if applicable).
  • I added or updated documentation (if applicable).
  • I tried running the project locally and verified that there are no
    visible errors.

Developer Certificate of Origin

For the purposes of this DCO, "license" is equivalent to "license or public domain dedication," and "open source license" is equivalent to "open content license or public domain dedication."

Developer Certificate of Origin
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

@Nenepo Nenepo requested review from a team as code owners October 4, 2024 07:49
@Nenepo Nenepo requested review from TimidRobot, possumbilities, shailee-m and dhruvkb and removed request for a team October 4, 2024 07:49
Copy link

netlify bot commented Oct 4, 2024

Deploy Preview for vocabulary-docs ready!

Name Link
🔨 Latest commit ff274d3
🔍 Latest deploy log https://app.netlify.com/sites/vocabulary-docs/deploys/66ff9e0848ddc40008344f6c
😎 Deploy Preview https://deploy-preview-79--vocabulary-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@possumbilities
Copy link
Contributor

Hi @Nenepo This PR seems to be unrelated to the Issue it is attached to:

#68 is about the default-page context (and perhaps others) within the Vocabulary design system, but your PR is making changes to the styles of the Vocabulary documentation site, which is both unrelated and supposed to allow horizontal scrolling of code blocks by intention.

Closing for now, please feel free to open new PRs in the future.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

[Bug] Mobile responsibility UI issue on default-page.html
2 participants