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

[Bug report] Better docs on renaming sidebar children #1238

Closed
nitrocode opened this issue Jan 15, 2023 · 3 comments
Closed

[Bug report] Better docs on renaming sidebar children #1238

nitrocode opened this issue Jan 15, 2023 · 3 comments
Labels
contribution welcome documentation Improvements or additions to documentation

Comments

@nitrocode
Copy link

Description

In v1, we can do the following and it will use configuring-atlantis.md and link it to Overview.

                {
                    text: 'Configuring Atlantis',
                    collapsible: true,
                    children: [
                        ['configuring-atlantis', 'Overview'],

I tried this but it didn't do what I expected

                {
                    text: 'Configuring Atlantis',
                    collapsible: true,
                    children: [
                        {
                            text: 'Overview',
                            children: ['configuring-atlantis'],
                        },

After playing with it, the answer is this

                {
                    text: 'Configuring Atlantis',
                    collapsible: true,
                    children: [
                        {
                            text: 'Overview',
                            link: 'configuring-atlantis',
                        },

This would be good to add under the sidebar section and it would be good to add for v1 migration to v2.

Reproduction

runatlantis/atlantis#2980

Used Package Manager

yarn

System Info

✗ npx vuepress info

  System:
    OS: macOS 13.1
    CPU: (8) x64 Intel(R) Core(TM) i5-8279U CPU @ 2.40GHz
    Memory: 28.42 MB / 16.00 GB
    Shell: 5.8.1 - /bin/zsh
  Binaries:
    Node: 18.13.0 - ~/.nvm/versions/node/v18.13.0/bin/node
    Yarn: 1.22.19 - /usr/local/bin/yarn
    npm: 8.19.3 - ~/.nvm/versions/node/v18.13.0/bin/npm
  Utilities:
    Git: 2.39.0 - /usr/local/bin/git
  Browsers:
    Chrome: 107.0.5304.110
    Edge: Not Found
    Firefox: 108.0.2
    Safari: 16.2
  npmPackages:
    @vuepress/bundler-vite: Not Found
    @vuepress/bundler-webpack: Not Found
    @vuepress/cli: Not Found
    @vuepress/client: Not Found
    @vuepress/core: Not Found
    @vuepress/markdown: Not Found
    @vuepress/plugin-active-header-links: Not Found
    @vuepress/plugin-back-to-top: Not Found
    @vuepress/plugin-container: Not Found
    @vuepress/plugin-docsearch: Not Found
    @vuepress/plugin-external-link-icon: Not Found
    @vuepress/plugin-git: Not Found
    @vuepress/plugin-google-analytics: Not Found
    @vuepress/plugin-medium-zoom: Not Found
    @vuepress/plugin-nprogress: Not Found
    @vuepress/plugin-palette: Not Found
    @vuepress/plugin-prismjs: Not Found
    @vuepress/plugin-pwa: Not Found
    @vuepress/plugin-pwa-popup: Not Found
    @vuepress/plugin-register-components: Not Found
    @vuepress/plugin-search: Not Found
    @vuepress/plugin-shiki: Not Found
    @vuepress/plugin-theme-data: Not Found
    @vuepress/plugin-toc: Not Found
    @vuepress/shared: Not Found
    @vuepress/theme-default: Not Found
    @vuepress/utils: Not Found
    vue: Not Found
    vue-loader: Not Found
    vue-router: Not Found
    vuepress: Not Found
    vuepress-vite: Not Found
    vuepress-webpack: Not Found
@nitrocode nitrocode changed the title [Bug report] Better documentation on renaming sidebar children [Bug report] Better docs on renaming sidebar children Jan 16, 2023
@meteorlxy
Copy link
Member

meteorlxy commented Jan 16, 2023

We already provide detailed explanation and some examples in the sidebar reference, including what you mentioned. What do you think is missing?

As for the migration guide, the default theme config has changed a lot. It's quite complex/verbose to provide a full list for migration, so we suggest users to go through the config reference.

@nitrocode
Copy link
Author

I suppose its in the sidebar section after all.

https://v2.vuepress.vuejs.org/reference/default-theme/config.html#sidebar

It would be nice to put in the migration doc. I've been trying to migrate v1 to v2 and the migration doc gets me about 80% there.

This particular case was a bit trickier for me to figure out because i wasnt aware that the children's array of arrays for retitling children was deprecated until i noticed that those children were completly missing after the migration...

@Mister-Hope
Copy link
Member

Pr is welcomed, I will sync Chinese docs once you create a pr

@meteorlxy meteorlxy added dependencies Pull requests that update a dependency file contribution welcome documentation Improvements or additions to documentation and removed dependencies Pull requests that update a dependency file labels Feb 3, 2023
fdevans added a commit to fdevans/vuepress-next that referenced this issue Sep 28, 2023
Per Issue vuepress#1238 added some highlights for theme changes related to sidebars that we had to dig for in theme config.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
contribution welcome documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants