Skip to content

docs: rebalance structured data positioning#53

Open
ilya-chizhov-a wants to merge 2 commits into
masterfrom
docs/landing-entry-blocks-review
Open

docs: rebalance structured data positioning#53
ilya-chizhov-a wants to merge 2 commits into
masterfrom
docs/landing-entry-blocks-review

Conversation

@ilya-chizhov-a
Copy link
Copy Markdown
Collaborator

@ilya-chizhov-a ilya-chizhov-a commented May 17, 2026

Summary

  • reframe the docs entry page around structured data modeling and generated APIs
  • keep Draft/HEAD/revisions as workflow mechanics instead of the central slogan
  • expand Data Modeling with UI/API behavior, examples, and next-step links

Validation

  • npm run build

Summary by CodeRabbit

  • Documentation

    • Expanded Data Modeling guidance covering schema capabilities, Admin UI and API generation, nested data handling, and practical use cases
    • Refreshed introductory content, navigation structure, and workflow descriptions throughout documentation
  • Style

    • Added styling for intro use cases section with responsive grid layout and card components, including dark mode support

Review Change Stack

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 17, 2026

Warning

Rate limit exceeded

@ilya-chizhov-a has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 57 minutes and 15 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: CHILL

Plan: Pro

Run ID: bfb4b160-4fa9-4cd2-bcf7-294ef8d63a08

📥 Commits

Reviewing files that changed from the base of the PR and between a9dcae9 and 2828e15.

📒 Files selected for processing (1)
  • docs/core-concepts/data-modeling.md
📝 Walkthrough

Walkthrough

This PR enhances the product documentation and landing page presentation. The Data Modeling concept page is expanded with clearer explanations of schema-to-UI and schema-to-API generation, plus a new section on nested data handling in the admin UI. The introduction page is revised with updated messaging emphasizing the schema-modeling-to-API-usage workflow and reorganized navigation tiles. Supporting CSS styling adds a responsive two-column use case card grid with dark mode support and mobile single-column layout.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'docs: rebalance structured data positioning' directly reflects the core objective of reframing documentation focus from Draft/HEAD revisions to structured data modeling and generated APIs.
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 docs/landing-entry-blocks-review

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.

coderabbitai[bot]
coderabbitai Bot previously requested changes May 17, 2026
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/core-concepts/data-modeling.md`:
- Line 25: Update the table cell that reads "`contentMediaType` / `format` |
Better editing affordances for markdown, dates, email, and rich text | Stronger
validation and clearer API contracts" to capitalize "Markdown" for consistency;
locate the string near the `contentMediaType` / `format` entry in
docs/core-concepts/data-modeling.md and change "markdown" to "Markdown" in that
table cell.
🪄 Autofix (Beta)

❌ Autofix failed (check again to retry)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 4e54b789-200d-4f34-92c6-1d696a5268e0

📥 Commits

Reviewing files that changed from the base of the PR and between 3618ff7 and a9dcae9.

📒 Files selected for processing (3)
  • docs/core-concepts/data-modeling.md
  • docs/intro.md
  • src/css/custom.css

Comment thread docs/core-concepts/data-modeling.md Outdated
Copy link
Copy Markdown

@cubic-dev-ai cubic-dev-ai Bot left a comment

Choose a reason for hiding this comment

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

No issues found across 3 files

Re-trigger cubic

@sonarqubecloud
Copy link
Copy Markdown

@ilya-chizhov-a ilya-chizhov-a dismissed coderabbitai[bot]’s stale review May 17, 2026 20:56

Addressed in 2828e15: capitalized Markdown in docs/core-concepts/data-modeling.md; CodeRabbit status is now passing.

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 18, 2026

Note

Autofix is a beta feature. Expect some limitations and changes as we gather feedback and continue to improve it.

Autofix skipped. No unresolved CodeRabbit review comments with fix instructions found.

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.

2 participants