Skip to content

Mention new admin panel homepage and update screenshots#2322

Merged
pwizla merged 2 commits intomainfrom
user/new-admin-panel-homepage-beta
Dec 18, 2024
Merged

Mention new admin panel homepage and update screenshots#2322
pwizla merged 2 commits intomainfrom
user/new-admin-panel-homepage-beta

Conversation

@pwizla
Copy link
Collaborator

@pwizla pwizla commented Dec 16, 2024

This PR is a MVP docs updates for the new admin panel homepage (beta)

Live preview 👉 here

Summary by CodeRabbit

  • New Features

    • Introduced a new callout section for improved navigation to Developer Docs, User Guide, and Strapi Cloud documentation.
    • Added a description of the admin panel homepage functionality, including the guided tour feature.
  • Documentation

    • Enhanced content structure with a numbered list for new users, outlining key steps and topics.
    • Updated sidebar configuration for better clarity and usability.

@vercel
Copy link

vercel bot commented Dec 16, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
documentation ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 16, 2024 2:49pm

@pwizla pwizla self-assigned this Dec 16, 2024
@pwizla pwizla added pr: updated content PRs updating existing documentation content source: User Guide PRs/issues targeting the User Guide labels Dec 16, 2024
@pwizla pwizla added this to the 5.5.0 milestone Dec 16, 2024
@yanniskadiri
Copy link
Contributor

LGTM, thanks @pwizla!

@pwizla pwizla added temp - port to docs-next (Temporary label) The content of this PR should be ported to docs-next.strapi.io flag: don't merge This PR should not be merged at the moment labels Dec 16, 2024
@coderabbitai
Copy link

coderabbitai bot commented Dec 16, 2024

Walkthrough

The pull request updates the Strapi User Guide's introduction documentation (intro.md). The changes focus on improving documentation clarity by adding a new callout section about documentation types, updating image sources, and providing a clearer navigation path for users. The modifications enhance the guide's structure with a numbered list of recommended steps for new users and include more descriptive information about the admin panel homepage.

Changes

File Change Summary
docusaurus/docs/user-docs/intro.md - Added callout section for documentation types
- Updated image sources
- Added description of admin panel homepage
- Included numbered user onboarding steps

Poem

🐰 A Rabbit's Guide to Docs So Bright

Strapi's welcome, clear and tight
Images fresh, paths now clear
Docs unfold without a fear
A journey starts with just one click
Welcome, traveler - learn quick! 🚀


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@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: 0

🧹 Nitpick comments (1)
docusaurus/docs/user-docs/intro.md (1)

36-37: Consider adding beta status information and improving accessibility

  1. Since the new admin panel homepage is in beta (as mentioned in the PR description), consider adding a note about its beta status to set proper expectations.
  2. The inline icon reference could be made more accessible.

Consider applying these changes:

-The ![Home icon](/img/assets/icons/v5/House.svg) admin panel homepage can display the guided tour (if you have not skipped or completed it yet) and last edited and published entries if you have any.
+:::note Beta feature
+The admin panel homepage (marked with the ![Home icon](/img/assets/icons/v5/House.svg "Home icon")) can display the guided tour (if you have not skipped or completed it yet) and last edited and published entries if you have any. This feature is currently in beta.
+:::
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 7a46770 and 02bee35.

⛔ Files ignored due to path filters (2)
  • docusaurus/static/img/assets/getting-started/admin-panel-homepage-2.png is excluded by !**/*.png
  • docusaurus/static/img/assets/getting-started/admin-panel-homepage-2_DARK.png is excluded by !**/*.png
📒 Files selected for processing (1)
  • docusaurus/docs/user-docs/intro.md (1 hunks)
🔇 Additional comments (2)
docusaurus/docs/user-docs/intro.md (2)

Line range hint 1-100: Documentation structure and content look good!

The documentation is well-structured, comprehensive, and the changes effectively document the new admin panel homepage while maintaining consistency with the existing content.


31-32: Verify the existence of the new screenshot files

Let's ensure the new screenshot files are properly added to the repository.

✅ Verification successful

Screenshot files are correctly added to the repository

Both the light mode (admin-panel-homepage-2.png) and dark mode (admin-panel-homepage-2_DARK.png) screenshots are present in the expected directory docusaurus/static/img/assets/getting-started/.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check if the new screenshot files exist in the repository
# Expected: Both light and dark mode images should be present

fd -t f "admin-panel-homepage-2.png" "docusaurus/static/img/assets/getting-started/"
fd -t f "admin-panel-homepage-2_DARK.png" "docusaurus/static/img/assets/getting-started/"

Length of output: 319

@pwizla pwizla removed the temp - port to docs-next (Temporary label) The content of this PR should be ported to docs-next.strapi.io label Dec 18, 2024
@pwizla pwizla merged commit 1820cb9 into main Dec 18, 2024
@pwizla pwizla deleted the user/new-admin-panel-homepage-beta branch December 18, 2024 13:20
@pwizla pwizla removed the flag: don't merge This PR should not be merged at the moment label Dec 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

pr: updated content PRs updating existing documentation content source: User Guide PRs/issues targeting the User Guide

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants