Skip to content

docs: update style guide#2657

Open
unatasha8 wants to merge 1 commit into
masterfrom
una-update-styleguide
Open

docs: update style guide#2657
unatasha8 wants to merge 1 commit into
masterfrom
una-update-styleguide

Conversation

@unatasha8

@unatasha8 unatasha8 commented Jul 1, 2026

Copy link
Copy Markdown
Contributor

Updated the style guide to add a new 'list' styling option that helps make content more scannable (label-plus-detail lists).

Issue: https://github.com/ory-corp/cloud/issues/12632

Checklist

  • [ X] I have read the contributing guidelines and signed the CLA.
  • I have referenced an issue containing the design document if my change introduces a new feature.
  • [ X] I have read the security policy.
  • [ X] I confirm that this pull request does not address a security vulnerability.
    If this pull request addresses a security vulnerability,
    I confirm that I got approval (please contact security@ory.com) from the maintainers to push the changes.
  • I have added tests that prove my fix is effective or that my feature works.
  • I have added the necessary documentation within the code base (if appropriate).

Summary by CodeRabbit

  • Documentation
    • Added a new list formatting guideline for bulleted items that use a bold label followed by an em dash and explanation.
    • Included an example showing the preferred “label + explanation” bullet style.

@coderabbitai

coderabbitai Bot commented Jul 1, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

This PR adds a new style guideline to README.md's "Lists" section, specifying that bulleted lists with parallel label-explanation items should bold the label followed by an em dash and the explanation, accompanied by an example.

Changes

Documentation update

Layer / File(s) Summary
List formatting guideline
README.md
Adds a new rule for bulleted lists pairing bolded labels with em dash and explanation text, plus an example.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Poem

A rabbit hops through docs so neat,
Bold labels dashed, a tidy feat—
Em dashes join what once was bare,
Lists now read with extra flair,
Hop hop, README's looking sweet!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title is concise and accurately reflects the documentation style guide update.
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.
Description check ✅ Passed The description includes the change summary, linked issue, and checklist, matching the template well; only optional further comments are omitted.
✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch una-update-styleguide

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant