docs: generic examples and decoupled concepts#5
Merged
Conversation
Follow-up to the usage-docs rewrite. The examples were lifted from the Redot Dashboard consumer app, so they referenced that app's models, variables, routes, and field names instead of illustrating generic usage. - Replace consumer-specific examples ($entry/$memo, dashboard.*/website.* routes, full_name/profile_picture, app-specific models) with a generic blog-style domain (Post/Category/User, posts.* routes, title/body/etc.) consistently across all sections. - Keep the package's real API accurate where it is the actual surface (auth routes/guards, Language model & lang jobs, datatable column/filter types, sidebar/toastify APIs, config keys, commands). - Decouple unrelated concepts: drop the unrelated no_content() rich-text example from the Controllers & Responses page (it belongs in Helpers).
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Follow-up to the usage-docs rewrite (#4). Fixes two problems with the examples.
Problem
$entry,$memo,dashboard.impersonate-users.store,full_name,profile_picture,Role::, …) instead of illustrating generic usage any developer could follow.no_content()— a rich-text display helper unrelated to HTTP responses.Changes
Post/Category/User,posts.*RESTful routes, fields liketitle/body/published_at/avatar) across 40 files.no_content()example from the Controllers & Responses page (it already lives in Helpers); each page now illustrates only its own feature.Languagemodel andlang:*jobs/commands, datatable column/filter types, the sidebar/toastify APIs, config keys, and the<x-layouts::dashboard>tag.Verification
npm run docs:buildpasses — no broken internal links across the updated cross-references.$entry/$memo, consumer route names, orfull_name/profile_picture.https://claude.ai/code/session_013Hi7rjhfimFsq6u4DxSZrR
Generated by Claude Code