Nuxt.js: No documentation of ignorePrefix option

[fzembow]

Version

v1.4.2

Reproduction link

https://nuxtjs.org/guide/configuration/

Steps to reproduce

In https://github.com/nuxt/nuxt.js/pull/2417, an option ignorePrefix was added, to remove files whose filenames begin with that from routing, layout and stores.

But if you go to https://nuxtjs.org/guide/routing/ there is nothing about it. I would also expect something in https://nuxtjs.org/guide/configuration/

What is expected ?

I would expect a sentence about ignoring pages in the documentation

What is actually happening?

The configuration option is undocumented and can only be found by googling github

Additional comments?

FWIW I agree with some of the comments from others about "-" being a poor filename prefix (because in the terminal it is interpreted as a flag) so this may be a good opportunity to revisit that.

_{This bug report is available on Nuxt community (#c7491)}

[manniL]

Why not add it to the docs by yourself as you now know about the feature? :relaxed:

PRs for https://github.com/nuxt/docs/ are always open and happily seen :ok_hand:

[fzembow]

Ah @manniL will do later today! Wanted to make sure I didn't forget this.

[Atinux]

A PR would be awesome 🙌

[fzembow]

Ah, I see that someone already added documentation to source (https://github.com/nuxt/docs/blob/master/en/api/configuration-ignore.md), it just hasn't deployed yet to nuxtjs.org/api?

Not sure how docs deployment works here, @manniL @Atinux. Closing this out as there's nothing for me to do. Might be good to add meta-documentation to https://github.com/nuxt/nuxtjs.org on how the docs actually get released :)

Anyways, I have the site running locally now so it should be easier to fix things in the future!

[Atinux]

Could you add the link into https://github.com/nuxt/docs/blob/master/en/api/menu.json please :) ?

[fzembow]

Thanks for the pointer. See https://github.com/nuxt/docs/pull/686 please!

[lock[bot]]

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.