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

[docs] Improve docs and address some ahrefs reported 404s #3928

Merged
merged 15 commits into from
Aug 19, 2024

Conversation

Janpot
Copy link
Member

@Janpot Janpot commented Aug 11, 2024

Address some ahrefs issues

  • Fix 404s
  • Add missing title and description

TO DO

@Janpot Janpot added the docs Improvements or additions to the documentation label Aug 11, 2024
@@ -4,7 +4,7 @@ title: Toolpad Overview

# Toolpad Core

<p class="description">A framework to build full-stack apps, fast. It can be used as a Next.js starter, or integrated within an existing React project to build dashboards and internal tools. </p>
Copy link
Member Author

@Janpot Janpot Aug 11, 2024

Choose a reason for hiding this comment

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

@prakhargupta1 @bharatkashyap This title is reported as too long. We'll need a shorter, more descriptive one.
Also remove 'framework'.

Copy link
Member

Choose a reason for hiding this comment

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

Changed it to: A set of full-stack components to build react dashboards.

@@ -14,6 +15,11 @@ import StudioIntro from '../../src/components/landing/StudioIntro';
export default function Home() {
return (
<BrandingCssVarsProvider>
<Head
title="Toolpad Core: Open-source dashboard framework for React"
description="Toolpad Core offers the components needed for your next admin panel and internal tools project."
Copy link
Member Author

@Janpot Janpot Aug 11, 2024

Choose a reason for hiding this comment

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

@prakhargupta1 This title/description was missing, might need better copy. Also may need a new twitter card image

@github-actions github-actions bot added the PR: out-of-date The pull request has merge conflicts and can't be merged label Aug 17, 2024
@github-actions github-actions bot removed the PR: out-of-date The pull request has merge conflicts and can't be merged label Aug 19, 2024
@prakhargupta1
Copy link
Member

There is a 404 warning for https://mui.com/home coming from https://mui.com/toolpad/core/react-page-container/. Olivier's suggestion: For /home we can replace this with /inbox we already have a case for those in the docs.

@prakhargupta1 prakhargupta1 changed the title [docs] Address some ahrefs reported 404s [docs] Improve docs and address some ahrefs reported 404s Aug 19, 2024
@@ -4,9 +4,9 @@ title: useNotifications
components: NotificationsProvider
---

# Notifications
# useNotifications
Copy link
Member Author

Choose a reason for hiding this comment

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

I think we can keep "Notifications" and instead change the title property above

Copy link
Member

@prakhargupta1 prakhargupta1 Aug 19, 2024

Choose a reason for hiding this comment

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

This is a suggestion to improve the DX, page h1 to be the same as sidenav title. We can choose between Notifications or useNotifications.

README.md Outdated Show resolved Hide resolved
Signed-off-by: Jan Potoms <[email protected]>
@Janpot Janpot marked this pull request as ready for review August 19, 2024 10:49
@Janpot Janpot merged commit 09a2a5d into mui:master Aug 19, 2024
14 checks passed
@Janpot Janpot deleted the 404s branch August 19, 2024 11:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to the documentation
Projects
Status: Completed
Development

Successfully merging this pull request may close these issues.

3 participants