WARNING: THIS SITE IS A MIRROR OF GITHUB.COM / IT CANNOT LOGIN OR REGISTER ACCOUNTS / THE CONTENTS ARE PROVIDED AS-IS / THIS SITE ASSUMES NO RESPONSIBILITY FOR ANY DISPLAYED CONTENT OR LINKS / IF YOU FOUND SOMETHING MAY NOT GOOD FOR EVERYONE, CONTACT ADMIN AT ilovescratch@foxmail.com
Skip to content

Conversation

@JavierMtzRdz
Copy link

@JavierMtzRdz JavierMtzRdz commented Dec 11, 2025

addresses issue(s) #1516

Summary:

This PR is the first part of the plan to split PR #1697 into smaller, manageable PRs. In particular, this update realigns the documentation design with the delphidocs.

Design & Style

  • Improved colour palette to match delphidocs style.
  • Added dedicated formatting for notes, warnings, and alerts.
  • Enabled tab formatting for code/content switching.
  • Added a hidden tabs_demo.md page to demonstrate how to use blockquotes, callouts, and tabs.
  • Enabled URLs to automatically render as clickable links.
updated-design

Prerequisites:

  • Unless it is a documentation hotfix it should be merged against the dev branch
  • Branch is up-to-date with the branch to be merged with, i.e. dev
  • Build is successful
  • Code is cleaned up and formatted

* Improved colour palette to match delphidocs style.
* Increase content area width and sdebar width (fixed #1516).
* Added callout formatting for notes, warnings, and alerts.
* Enabled tab formatting for code/content switching.
* Added a hidden tabs_demo.md page to demonstrate how to use blockquotes, callouts, and tabs.
Copy link
Contributor

@nmdefries nmdefries left a comment

Choose a reason for hiding this comment

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

Looks good so far. Thanks for adding code tabs and auto-text-width adjusting!

I'd like to go over where some of the colors show up, since sonarcloud is giving us warnings about the contrast.

* Change link colour from cmu-red to skibo-red
* Adjust navigation bar colour and hover/active SCSS
* Exclude tans_demo.md from being searchable.
@sonarqubecloud
Copy link

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

Successfully merging this pull request may close these issues.

Consider enabling flexible page width for doc site

3 participants