Skip to content

Docs/example fixes #3687

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

Open
wants to merge 10 commits into
base: master
Choose a base branch
from
Open

Docs/example fixes #3687

wants to merge 10 commits into from

Conversation

ethanshar
Copy link
Collaborator

@ethanshar ethanshar commented Apr 20, 2025

Description

Improve various components snippets (code examples)

Changelog

NA

Additional info

@@ -26,7 +26,8 @@ const VALID_COMPONENTS_CATEGORIES = [
'incubator',
'infra',
// non components categories
'services'
'services',
'dev' // development category for components we don't want to render in our docs (used in test.api.json)
Copy link
Collaborator

Choose a reason for hiding this comment

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

Do we want to add this to the sidebars? Perhaps only in the next version?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

How do you recommend doing it only for next?

Copy link
Collaborator

Choose a reason for hiding this comment

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

We can add it to

incubator: 'Incubator',
infra: 'Infra'
};

Now that I see there a huge difference between the design of the sidebars in the regular version then in the next version. In the regular version theres dividers and such.
I guess it was added here manually. we'll have to adjust the sidebars script to generate that, we need to add that to the components sidebar. I'll create a pr.

    {
      type: 'category',
      label: 'Incubator',
      collapsible: false,
      items: [
        {
          type: 'autogenerated',
          dirName: `components/infra`
        }
      ]
    },
    {
      type: 'category',
      label: 'Infra',
      collapsible: false,
      items: [
        {
          type: 'autogenerated',
          dirName: `components/infra`
        }
      ]
    }

Copy link
Collaborator

Choose a reason for hiding this comment

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

@nitzanyiz nitzanyiz assigned ethanshar and unassigned nitzanyiz Apr 21, 2025
@ethanshar ethanshar assigned nitzanyiz and unassigned ethanshar Apr 22, 2025
@ethanshar ethanshar requested a review from nitzanyiz April 22, 2025 10:49
@nitzanyiz nitzanyiz assigned ethanshar and unassigned nitzanyiz Apr 22, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants