Skip to content

fix(docs): correct nested list rendering in docs site#2098

Merged
Y3drk merged 6 commits into
mainfrom
fix/docs-list-indentation
May 14, 2026
Merged

fix(docs): correct nested list rendering in docs site#2098
Y3drk merged 6 commits into
mainfrom
fix/docs-list-indentation

Conversation

@notrab
Copy link
Copy Markdown
Member

@notrab notrab commented May 12, 2026

Lite PR

Tip: Review docs on the ENSNode PR process

Summary

Before After
CleanShot 2026-05-12 at 16 53 08@2x
CleanShot 2026-05-12 at 17 04 51@2x

Why

  • Why this change exists. Link to related GitHub issues where relevant.

Testing

  • How this was tested.
  • If you didn't test it, say why.

Notes for Reviewer (Optional)

  • Anything non-obvious or worth a heads-up.

Pre-Review Checklist (Blocking)

  • This PR does not introduce significant changes and is low-risk to review quickly.
  • Relevant changesets are included (or are not required)

@vercel
Copy link
Copy Markdown
Contributor

vercel Bot commented May 12, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
admin.ensnode.io Ready Ready Preview, Comment May 14, 2026 0:21am
enskit-react-example.ensnode.io Ready Ready Preview, Comment May 14, 2026 0:21am
ensnode.io Ready Ready Preview, Comment May 14, 2026 0:21am
ensrainbow.io Ready Ready Preview, Comment May 14, 2026 0:21am

@changeset-bot
Copy link
Copy Markdown

changeset-bot Bot commented May 12, 2026

⚠️ No Changeset found

Latest commit: 6a9356a

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 12, 2026

Review Change Stack

Warning

Rate limit exceeded

@Y3drk has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 59 minutes and 27 seconds before requesting another review.

You’ve run out of usage credits. Purchase more in the billing tab.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: 2bfc3c09-2e33-4384-91fe-41865eb8452d

📥 Commits

Reviewing files that changed from the base of the PR and between 8c9c046 and 6a9356a.

📒 Files selected for processing (1)
  • docs/ensnode.io/src/content/docs/docs/services/ensdb/concepts/database-schemas.mdx
📝 Walkthrough

Walkthrough

This PR reformats contributor and terminology MDX content for consistent markdown list and section rendering, and consolidates Starlight CSS list rules (.sl-markdown-content) to standardize list color, spacing, and indentation across the docs site.

Changes

Contributor docs & list styling

Layer / File(s) Summary
PR template & changeset docs formatting
docs/ensnode.io/src/content/docs/docs/reference/contributing/prs.mdx
Reflowed PR template bullets, Standard PR Process steps, and changeset version-bump instructions; added spacing around the "Important notes" section and inserted placeholder blank lines in examples.
Terminology list and snippet formatting
docs/ensnode.io/src/content/docs/docs/reference/terminology.mdx
Reformatted "Subregistry" and "Shadow Registry" lists, adjusted spacing in "Literal/Interpreted" and "Subgraph Indexability" sections, and changed a displayed enssdk import from single to double quotes.
Starlight markdown list styling consolidation
docs/ensnode.io/src/styles/starlight.css
Added .sl-markdown-content :where(ul, ol) to centralize list text color, margin-block, and padding-inline-start; simplified ul/ol rules to list-style only and tightened nested-list indentation and vertical spacing.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

Suggested labels

docs

Poem

A rabbit edits lines with care,
Aligns each list and trims the air,
Quotes fixed, margins neat and bright,
Docs hop forward, calm and light. 🐇✨

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The PR description follows the template structure but lacks substantive content in critical sections (Why, Testing, Notes for Reviewer are empty). Complete the 'Why' section explaining the rationale for these formatting changes, fill in the 'Testing' section describing how the list rendering was validated, and add any relevant notes for reviewers.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main change: fixing nested list rendering in the documentation site by updating CSS and markdown formatting.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix/docs-list-indentation

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR fixes nested list rendering issues on the ENSNode docs site by adjusting Starlight markdown list styling, and updates the PR-process documentation formatting to render nested lists as intended.

Changes:

  • Update .sl-markdown-content list CSS to use consistent margins/indentation for ul/ol.
  • Tweak prs.mdx markdown formatting/indentation so nested lists render correctly.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

File Description
docs/ensnode.io/src/styles/starlight.css Adjusts list spacing/indent rules for markdown content to improve nested list rendering.
docs/ensnode.io/src/content/docs/docs/reference/contributing/prs.mdx Fixes markdown nesting/italics formatting so lists render properly in the docs site.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread docs/ensnode.io/src/styles/starlight.css Outdated
Comment thread docs/ensnode.io/src/styles/starlight.css Outdated
Copy link
Copy Markdown
Contributor

Copilot AI commented May 13, 2026

Just as a heads up, I was blocked by some firewall rules while working on your feedback. Expand below for details.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

  • fonts.googleapis.com
    • Triggering command: /home/REDACTED/work/_temp/ghcca-node/node/bin/node node /home/REDACTED/work/ensnode/ensnode/docs/ensnode.io/node_modules/.bin/../astro/astro.js build (dns block)
  • telemetry.astro.build
    • Triggering command: /home/REDACTED/work/_temp/ghcca-node/node/bin/node node /home/REDACTED/work/ensnode/ensnode/docs/ensnode.io/node_modules/.bin/../astro/astro.js build (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

Copilot finished work on behalf of notrab May 13, 2026 17:01
Copy link
Copy Markdown
Contributor

@vercel vercel Bot left a comment

Choose a reason for hiding this comment

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

Additional Suggestions:

  1. CSS rule uses physical property margin-top while parent selector uses logical properties, breaking RTL language support
  1. Nested list rule uses physical margin-top property while parent list uses logical properties, breaking RTL language support

Fix on Vercel

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated no new comments.

@notrab notrab marked this pull request as ready for review May 13, 2026 21:42
@notrab notrab requested a review from a team as a code owner May 13, 2026 21:42
Copilot AI review requested due to automatic review settings May 13, 2026 21:42
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 4 out of 4 changed files in this pull request and generated no new comments.

@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps Bot commented May 13, 2026

Greptile Summary

This PR fixes broken nested list rendering on the ENSNode docs site by correcting the root CSS cause (list-style-position: inside replaced with padding-inline-start) and updating MDX source files to use proper CommonMark list syntax (blank lines before lists, dash markers, correct sub-item indentation).

  • starlight.css: Drops list-style-position: inside (which collapsed nested lists into the text flow), introduces padding-inline-start: 40px for top-level lists, and generalises the nested-list selector to cover ol > ul and ul > ol cases alongside ul > ul.
  • MDX files (prs.mdx, terminology.mdx, database-schemas.mdx): Adds blank lines before every list block, converts * bullets to -, fixes sub-item indentation from 2 to 3 spaces, and reformats all Markdown tables to properly align columns.

Confidence Score: 5/5

Docs-only change touching CSS and MDX files; no runtime logic affected.

All four changed files are documentation assets (CSS + MDX). The CSS fix correctly replaces the problematic list-style-position: inside rule with standard padding-inline-start and updates nested-list selectors. MDX edits are mechanical reformatting. No application logic, APIs, or data are touched.

No files require special attention.

Important Files Changed

Filename Overview
docs/ensnode.io/src/styles/starlight.css Refactors list CSS: replaces list-style-position: inside (root cause of broken nesting) with proper padding-inline-start, updates nested list selectors, and removes the ::marker accent color rule.
docs/ensnode.io/src/content/docs/docs/reference/contributing/prs.mdx Fixes nested list Markdown: adds blank lines before list blocks, converts asterisk bullets to dashes, and corrects sub-item indentation from 2 to 3 spaces to satisfy MDX/CommonMark nesting rules.
docs/ensnode.io/src/content/docs/docs/reference/terminology.mdx Converts all asterisk list markers to dashes, adds blank lines before lists and section headings, and normalises a TypeScript code snippet's string quotes from single to double.
docs/ensnode.io/src/content/docs/docs/services/ensdb/concepts/database-schemas.mdx Reformats all Markdown tables to align columns, adds blank lines before list blocks, adds a new :::note callout in the domains section; the previously-indented a)/b) continuation items are now flush-left (pre-existing flagged item).

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[MDX source files<br/>prs.mdx / terminology.mdx<br/>database-schemas.mdx] -->|Markdown list syntax<br/>blank lines + dash markers<br/>3-space sub-item indent| B[Starlight MDX parser]
    B -->|Generates HTML<br/>ul / ol / li elements| C[Rendered HTML]
    D[starlight.css] -->|list-style: disc / decimal<br/>padding-inline-start: 40px<br/>nested: padding-inline-start: 1.5em| C
    C --> E[Correct nested list<br/>rendering in browser]

    style A fill:#e8f4f8
    style D fill:#e8f4f8
    style E fill:#d4edda
Loading

Reviews (2): Last reviewed commit: "Merge branch 'main' into fix/docs-list-i..." | Re-trigger Greptile

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.

| `root_registry_owner_id` | `text` | yes | ENSv1 only: the owner recorded in the root ENSv1 registry. `null` for ENSv2 domains. |
| `canonical` | `boolean` | no | Whether this Domain is part of the canonical nametree. This encodes bi-directional agreement between `domains.subregistry_id` and `registries.canonical_domain_id`, so traversal of the canonical nametree filtered to domains/registries where `canonical=true` is safe and doesn't require edge-authenticating oneself (i.e. don't need to compare `domains.subregistry_id` and `registries.canonical_domain_id` in the query, can just `WHERE canonical = true`). Mirrors the parent Registry's flag. Default `false`. |
:::note
Domain-Resolver relations are tracked via the Protocol Acceleration plugin, not stored on the domain row. The parent domain is derived via `registry_canonical_domains`, not stored on the domain row.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I defer to what was on the main branch in terms of the actual content

Copy link
Copy Markdown
Member

@Y3drk Y3drk left a comment

Choose a reason for hiding this comment

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

Identations now work correctly (verified all highlighted errors in Vercel).

Created a follow-up issue for a bug spotted when reviewing the PR, that's out of its scope → #2119

@Y3drk Y3drk merged commit 1fbdc1d into main May 14, 2026
25 checks passed
@Y3drk Y3drk deleted the fix/docs-list-indentation branch May 14, 2026 13:07
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.

5 participants