Skip to content

Conversation

@VerzatileDev
Copy link
Contributor

@VerzatileDev VerzatileDev commented Jan 16, 2024

Reference

The following Pull Request in response to issue #74 on the VerzatileDevOrg/Programming_HandBook repository, which can be referenced at #74.

Addressable

The primary focus of this Pull Request is to address the current default Color-Theme of the website, which is currently set to Light or White, as highlighted in issue (#44).

Changes

  1. Modification of collections to utilize proper Hex Coloring.

  2. Documentation and organization of collections for clarity.
    Introduction of the ability to assign a title to each collection, exemplified as follows: {: .code title="Specified Title"}
    Refinement of the interaction between the .code and .example classes for codeblocks.
    Addition of a purple outline on the side of codeblocks by default.

Enhancement

<h1> titles for improved visibility on the page, accompanied by the introduction of padding properties to separate the content from the underlying text.

In the following Update back to top feature under each page's footer can now be changed to not be included by using the following command " back_to_top: false ", where as it is by default controlled globally, the default value in config has now moved to the Default.html itself so that in the feature different templates can be used.
Collections are now documented and organized specific to the Light theme of the current website, using Hex Color scheme, and titles can now be specified manually for each collection by the use of : {: .collection title="NewTitle"} if it is not defined the specified collection uses the default written title which is based on the name of itself.

Note that collection Title can be written as empty as well if there is not a requirement to display it!

Just use :  title= ""  instead.

Made Adjustments within Code.scss, where each code block would not display a box-shadow around itself, as well as on the left side of it use a border colour.
Addionally change the way code block titles are being handled and made a specified collection tag specifically for it, it can be used with the .highlight system under code.scss or it can be used separately as a standalone example without using the CodeBlock, with the copy button and a few other features.
As there is now a specified Warning message, I think the Image is no longer required, and it would as well free up resources, to be less rate-limited in the future (The less Images the better).

I think it also changes the Visual appeal of the website to be more lack-luster if left on, with that decision it has now been Removed.
Previously the Title of the page seemed to look irrelevant, it now has been improved with a considerable change to give it more space from the rest of the content, as well as make it stand out more on what page the reader currently is sat on.
@VerzatileDev VerzatileDev added 🌈 Type: Cosmetic Edits to layout or looks. 👁️ Review: Required This PR is ready for review. labels Jan 16, 2024
Copy link
Collaborator

@JDSherbert JDSherbert left a comment

Choose a reason for hiding this comment

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

lgtm, lets make sure we do this for the rest of the docs as well.

@JDSherbert JDSherbert merged commit 3c52543 into VerzatileDevOrg:main Jan 16, 2024
@JDSherbert JDSherbert added ✅ Review: Approved PR is approved and ready for merge. and removed 👁️ Review: Required This PR is ready for review. labels Jan 16, 2024
@VerzatileDev VerzatileDev deleted the Feature_Interface_Updates branch January 24, 2024 21:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

✅ Review: Approved PR is approved and ready for merge. 🌈 Type: Cosmetic Edits to layout or looks.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants