Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Panels navigation documentation #15109

Open
wants to merge 10 commits into
base: 3.x
Choose a base branch
from

Conversation

ModestasV
Copy link
Contributor

Description

Documentation updates for Panels -> Navigation.

This includes a few non-documentation updates:

  1. I have refactored the routes to be grouped instead of the panels/navigation... prefix (Commit)
  2. Fixed a bug with the generation script where having a Dark preference would not generate Light screenshots (Commit)

And, of course, added images for:

In one case, I had to split the text better to visualize the difference (Collapsible vs. not group).

Other than that - let me know if this is okay :)

Visual changes

None

Functional changes

  • Code style has been fixed by running the composer cs command.
  • Changes have been tested to not break existing functionality.
  • Documentation is up-to-date.

@danharrin danharrin added the documentation Improvements or additions to documentation label Dec 17, 2024
@danharrin danharrin added this to the v3 milestone Dec 17, 2024
@@ -376,6 +402,8 @@ public function panel(Panel $panel): Panel
}
```

<AutoScreenshot name="panels/navigation/custom-items" alt="Register Custom Navigation Items" version="3.x" />
Copy link
Member

Choose a reason for hiding this comment

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

Please do not use Title Case for the alt text within screenshots, please check this is consistent with existing screenshots :)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Heh, sorry about that! Too used to Title Case :)

Copy link
Member

Choose a reason for hiding this comment

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

Maybe we could use a badge for the sort number instead of putting it in the label?

Copy link
Member

Choose a reason for hiding this comment

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

Maybe the example here could be an -o- cog and a -s- cog?

Route::get('layout', InfolistsLayoutDemo::class);
});

Route::group(['prefix' => 'panels'], function () {
Copy link
Member

Choose a reason for hiding this comment

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

Can we use Route::prefix() here please for better static analysis

Copy link
Member

Choose a reason for hiding this comment

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

Can we use the same empty view across multiple pages instead of duplicating?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: In Progress
Development

Successfully merging this pull request may close these issues.

2 participants