Skip to content

docs: Standardize landing page format#4170

Merged
geoffreynyaga merged 2 commits intomainfrom
diataxis-landing-page-fix
Oct 2, 2025
Merged

docs: Standardize landing page format#4170
geoffreynyaga merged 2 commits intomainfrom
diataxis-landing-page-fix

Conversation

@geoffreynyaga
Copy link
Contributor

@geoffreynyaga geoffreynyaga commented Jun 18, 2025

This PR updates the landing page (specifically the "In this documentation" section) to align with the standardized format used across other canonical products , improving consistency and user experience.

Changes Made

  • Replaced markdown table with a responsive grid layout (and cards) for and aligning to design patterns of other canonical products.

Reference implementation

The new format follows the same structure as other canonical product documentation:
Chisel docs
Ubuntu server docs

Testing

  • Verified layout renders correctly across different screen sizes
  • Confirmed all links and navigation elements function properly

Screenshots

Before

Screenshot 2025-06-18 at 09 27 37

After

Screenshot 2025-06-18 at 09 55 12

MULTI-2031

@codecov
Copy link

codecov bot commented Jun 18, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 89.44%. Comparing base (408f122) to head (7ad0ab1).
⚠️ Report is 124 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #4170      +/-   ##
==========================================
+ Coverage   89.35%   89.44%   +0.09%     
==========================================
  Files         259      260       +1     
  Lines       15743    15818      +75     
==========================================
+ Hits        14067    14149      +82     
+ Misses       1676     1669       -7     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@sharder996 sharder996 requested review from Sploder12 and msuchane June 27, 2025 15:08
@msuchane
Copy link
Collaborator

msuchane commented Jul 1, 2025

Reviewed, looks good.

I'm using a slightly different syntax on Desktop, but the end result should be the same. Adding just for reference:

::::{grid} 1 1 2 2

:::{grid-item-card} Tutorial
:link: /tutorial/index
:link-type: doc

**Get started**: a hands-on introduction to Ubuntu Desktop for new users
:::

:::{grid-item-card} How-to guides
:link: /how-to/index
:link-type: doc

**Step-by-step guides** covering key operations and common tasks
:::
::::

Note two differences:

  • I'm using colon-fenced blocks. Thanks to them, I get some syntax highlighting within the blocks that would otherwise be obscured by the code block. No functional difference other than that.

  • I'm using a different way to specify the page link. I honestly don't know whether to prefer one or the other. Both notations report a build error when the link is broken, so they should be the same.

msuchane
msuchane previously approved these changes Jul 1, 2025
Sploder12
Sploder12 previously approved these changes Jul 23, 2025
Copy link
Contributor

@Sploder12 Sploder12 left a comment

Choose a reason for hiding this comment

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

LGTM! Page looks nice and links work

@sharder996 sharder996 force-pushed the diataxis-landing-page-fix branch from a360c93 to 47a0bc9 Compare July 24, 2025 00:12
@sharder996 sharder996 dismissed stale reviews from msuchane and Sploder12 via c2fab12 July 25, 2025 02:50
@sharder996 sharder996 force-pushed the diataxis-landing-page-fix branch from 47a0bc9 to c2fab12 Compare July 25, 2025 02:50
@sharder996 sharder996 changed the base branch from main to whitespace-exclusions July 25, 2025 02:51
@sharder996
Copy link
Collaborator

@geoffreynyaga One small, real linting error this time 😸

Base automatically changed from whitespace-exclusions to main July 25, 2025 03:34
@geoffreynyaga geoffreynyaga enabled auto-merge August 4, 2025 11:40
@sharder996 sharder996 force-pushed the diataxis-landing-page-fix branch from c2fab12 to 7d5ed79 Compare August 14, 2025 19:53
@sharder996
Copy link
Collaborator

One small, real linting error this time 😸

@geoffreynyaga

@geoffreynyaga geoffreynyaga force-pushed the diataxis-landing-page-fix branch from 12f0b5c to 7ad0ab1 Compare August 25, 2025 07:16
@Sploder12 Sploder12 force-pushed the diataxis-landing-page-fix branch from 7ad0ab1 to 4910d5f Compare August 25, 2025 10:59
@geoffreynyaga geoffreynyaga self-assigned this Oct 2, 2025
@geoffreynyaga geoffreynyaga force-pushed the diataxis-landing-page-fix branch from 4910d5f to ce281ac Compare October 2, 2025 15:25
@geoffreynyaga geoffreynyaga force-pushed the diataxis-landing-page-fix branch from ce281ac to 9f15090 Compare October 2, 2025 15:49
Copy link
Collaborator

@sharder996 sharder996 left a comment

Choose a reason for hiding this comment

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

Thanks, @geoffreynyaga!

@geoffreynyaga geoffreynyaga added this pull request to the merge queue Oct 2, 2025
Merged via the queue into main with commit e327e03 Oct 2, 2025
9 checks passed
@geoffreynyaga geoffreynyaga deleted the diataxis-landing-page-fix branch October 2, 2025 16:00
geoffreynyaga added a commit that referenced this pull request Jan 21, 2026
This PR updates the landing page (specifically the "In this
documentation" section) to align with the standardized format used
across other canonical products , improving consistency and user
experience.

## Changes Made

- Replaced markdown table with a responsive grid layout (and cards) for
and aligning to design patterns of other canonical products.

## Reference implementation

The new format follows the same structure as other canonical product
documentation:
• [Chisel docs](https://documentation.ubuntu.com/chisel/en/latest/)
• [Ubuntu server docs](https://documentation.ubuntu.com/server/)

## Testing

- [x] Verified layout renders correctly across different screen sizes
- [x] Confirmed all links and navigation elements function properly

## Screenshots
### Before
<img width="810" alt="Screenshot 2025-06-18 at 09 27 37"
src="https://github.com/user-attachments/assets/fb0436a1-a634-4575-823b-7e0224e6d6ad"
/>

### After

<img width="776" alt="Screenshot 2025-06-18 at 09 55 12"
src="https://github.com/user-attachments/assets/74574d58-e1b8-4084-bfa9-3d73b9c37a06"
/>

MULTI-2031
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.

4 participants