Index list #196
Index list #196
Conversation
| description: Purpose and usage of index.list | ||
| --- | ||
|
|
||
| ## What is `index.list` |
There was a problem hiding this comment.
Having a separate reference seems to me excessively verbose and a poor fit in the current API reference structure.
index.list is not an API, why should it be there?
Let's try something simpler. The example and screenshots are certainly not required. Add a new section to the WebDevice reference instead with a shorted version of this guide.
The most important thing that is' missing is to explain people how to create this file. Try to build a find oneliner that creates the file. Keep in mind that you cannot simply do ls > index.list since index.list will then spuriously appear in the listing. The combination of ls > .index.list + mv .index.list index.list might work.
|
|
||
| To be able to list the files, CheerpX will look for a file called index.list in the directory and each of its subdirectories. The file should contain a newline separated list of all files and folders contained in the directory. | ||
| ### Why use an `index.list` File? |
There was a problem hiding this comment.
Please do not capitalize words that are not the first word or aren't proper names. Please apply this correction to all the titles and subtitles of this guide.
|
@GabrielaReyna Do you want me to add a reference to .create for all the devices from the Files and filesystems guide? I think removing information would make the guide lose its purpose. I could add all the device information in the .create reference section with information on how to create the devices but I feel like that would be double the information. What do you think? |
|
We will add this to the reference when we re-organise the structure, we can merge this PR as it is for now. if the other requests have been fulfilled. |
|
Please ping me once Alessandro approves the technical changes. |
No description provided.