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

Hide files or use a filelist config #2

Open
kirkroberts opened this issue Feb 26, 2015 · 2 comments
Open

Hide files or use a filelist config #2

kirkroberts opened this issue Feb 26, 2015 · 2 comments

Comments

@kirkroberts
Copy link

Love this plugin. Thank you so much for creating and sharing it.

Here are a couple of feature ideas if you're open to them.

  1. use a config file to set the sidebar nav order and titles. This would enable easily rearranging files without renaming them, and also would avoid breaking/maintaining internal links. Would also allow having files in the _help folder that are hidden from the user (useful for files that aren't ready or needed yet).
  2. enable hiding files by some naming convention, e.g. prefixing the filename with two underscores.

Thanks again!

@ktbartholomew
Copy link
Contributor

Hey @kirkroberts glad to hear you're enjoying the plugin.

  1. I agree, having to rename files to add a new page at the beginning of a list is cumbersome. I myself was just bit by this recently. I'm not sure a config file would much better though, as it would require people to mess around with a big nested PHP array. I'm also struggling to think of a good way to halfway embrace this approach. I would have to choose the file naming way or the config file way, there's no room for both.
  2. I'm not sure I understand the use case for this. If you're hiding a file from the help section, why is it there in the first place?

Good ideas though, I'm open to additional thoughts you may have.

@kirkroberts
Copy link
Author

Thanks @ktbartholomew !

  1. I think a PHP array would be much better, but I'm used to dealing with such things. Might seem like a lateral move when first setting it up but anytime it gets edited it will be SO much easier. If there are internal links, then even more so. Also allows for managing the sidebar nav order/titles in one place. I'm thinking long-term with adding help docs as needed over the lifespan of a site, which hopefully is several years or more. Re "halfway" / backwards compatibility: perhaps look for the config file, and if it isn't there use the old/current filenaming method.
  2. I agree this is at best an edge case: I'm thinking about keeping boilerplate help files together and dropping them all in and only showing as needed, or keeping your original Getting Started file. Probably not worth extra development, but it would be taken care of automatically if the config idea is implemented.

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

No branches or pull requests

2 participants