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] Add placeholders for upcoming features #4175

Merged
merged 4 commits into from
Oct 10, 2024

Conversation

prakhargupta1
Copy link
Member

@prakhargupta1 prakhargupta1 commented Sep 30, 2024

@prakhargupta1 prakhargupta1 added the docs Improvements or additions to the documentation label Sep 30, 2024
@prakhargupta1 prakhargupta1 marked this pull request as ready for review September 30, 2024 15:12
@bharatkashyap
Copy link
Member

I think the idea was to add individual pages with links to the issue from each page, with a standard work in progress warning callout on each of these pages. The benefit would be that the features would show up in the navigation instead of the roadmap page which might not be viewed by as many people. Not sure if I understood incorrectly.

Benchmark: https://mui.com/x/react-data-grid/server-side-data/aggregation/

@prakhargupta1
Copy link
Member Author

prakhargupta1 commented Oct 1, 2024

I thought adding 9-10 items as separate pages in the side nav would be too much noise for the readers. I think they should just be links to the issues grouped together on a single page. We can put this group in multiple places:

  1. Overview page
  2. All Components page
  3. As a separate category of 'Upcoming features' as the fourth item on the main list:
    • Introduction
    • Components
    • Upcoming features (Here, if needed for each of them we can add a few lines explaining them)
    • APIs

@bharatkashyap
Copy link
Member

I thought adding 9-10 items as separate pages in the side nav would be too much noise for the readers. I think they should just be links to the issues grouped together on a single page. We can put this group in multiple places:

  1. Overview page

  2. All Components page

  3. As a separate category of 'Upcoming features' as the fourth item on the main list:

    • Introduction
    • Components
    • Upcoming features (Here, if needed for each of them we can add a few lines explaining them)
    • APIs

Perhaps not all, but I definitely think these items are only discoverable if they are in the navigation sidebar; otherwise the discoverability of these is quite low in my opinion, might not help us attract as much attention as we want. Let me know what you think

@Janpot
Copy link
Member

Janpot commented Oct 7, 2024

Backlog grooming proposal:

  • likely not enough visibility in this section
  • remove the section in the introduction page
  • put it in navigation as items (us "planned" chip as X) + placeholder pages like https://mui.com/x/react-charts/gantt/
  • retain the following:
    • data section with
      • CRUD
      • stat card
    • under authentication section
      • Sign-up page
      • RBAC components
    • under layout
      • notification center

@prakhargupta1 prakhargupta1 requested a review from a team October 9, 2024 09:21
Co-authored-by: Jan Potoms <2109932+Janpot@users.noreply.github.com>
Signed-off-by: Prakhar Gupta <92228082+prakhargupta1@users.noreply.github.com>
@prakhargupta1 prakhargupta1 merged commit f117c3e into mui:master Oct 10, 2024
14 checks passed
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
None yet
Development

Successfully merging this pull request may close these issues.

[docs] Add placeholder pages to the docs with potential future features
3 participants