Yes. That is the right sequence.
Recommended order
Before rebuilding the full docs tree, we should do this first:
1. Freeze the likely document set
Settle the core document list in English first.
2. Write better English stubs
Each stub should already contain:
So they become real starter documents, not empty shells.
3. Rebuild the tree around index_{lang}.html
Then regenerate the docs tree using the cleaned structure.
4. Translate later
Once the English architecture is stable, the other languages can mirror it.
That is much cleaner than rebuilding a whole tree before the doc set is settled.
State parameter naming change
Agreed.
New rule
Remove all _ underscores from:
Use upper/lower case letters only.
So instead of:
use:
Or, if you want the state object to remain visually stronger at the top of file, we can use:
We should pick one style and use it consistently.
Best naming recommendation
For clarity and modern readability, I recommend:
In code and state object
camelCase
Example:
Why:
In GET strings
Use the same names, but document that they are case-insensitive.
Example canonical export:
But all of these must work the same:
So the spec becomes:
GET variables are case-insensitive.
Exported examples may use aesthetically capitalized forms for readability, but capitalization is not required.
That is a very good rule.
Suggested canonical naming style
State object
Use clean camelCase:
GET export
Export in a readable canonical form, for example:
And document clearly:
Most likely document set
Here is the set I think we should solidify first for English.
Core docs
-
Quick Start
-
Controls
-
Playlist Format
-
Documents System
-
State Object
-
GET Parameters
-
Local File Mode
-
Remote Playlist Loading
-
Output Resolutions and Aspect Ratios
-
Export / Reproduction
-
FAQ
-
Version Notes / Release Notes
That feels like the strongest likely core.
Recommended English stub filenames
Using your new language-folder pattern:
That is clean, explicit, and future-proof.
Short English descriptions for the index
These are good starting descriptions for the link list.
Quick Start
How to begin using the app immediately with the least possible setup and confusion.
Controls
What each visible control does and how the control bar changes the interface.
Playlist Format
How _MyAnythingList.txt works, how URLs are extracted, and what text is ignored.
Documents System
How the Documents button works, how language folders are organized, and how the docs tree is structured.
State Object
How the top-of-file state object controls the application and which parameters matter most.
GET Parameters
How URL query parameters reproduce interface state and how case-insensitive parameter names work.
Local File Mode
What works in file:// mode, what does not, and why some embedded media behavior changes locally.
Remote Playlist Loading
How remote UTF-8 text playlists are loaded from the web and what servers must allow.
Output Resolutions and Aspect Ratios
How output size options work and how the resolution list is sorted by X dimension.
Export / Reproduction
How to capture the current interface state as a URL or JavaScript object.
FAQ
Answers to practical and recurring questions about the app.
Version Notes
What changed in the current build and how to identify exact released versions.
Paragraph-length explanations for the index
These are the “smart reader” summaries that go beneath the links.
Quick Start
Quick Start is for first-time users who want to understand how to open the application, load a playlist, and begin browsing content without reading the entire documentation set first. It focuses on the shortest path from opening the app to seeing usable results on screen.
Controls
Controls explains the visible interface elements in the control bar and editor, including what each setting changes and how the controls relate to one another. It is meant for users who want explicit and practical understanding of the interface instead of trial and error.
Playlist Format
Playlist Format explains the free-form UTF-8 text philosophy behind _MyAnythingList.txt. It describes how the app extracts valid URLs from anywhere in the text, ignores lines beginning with #, and preserves sequence so a human-readable document can still function as a machine-readable playlist.
Documents System
Documents System explains how documentation is organized by language, how the Documents button finds the correct file, and how the docs tree is designed to remain human-browsable both in Apache directory listings and inside the app itself.
State Object
State Object explains the full exposed interface state at the top of the file. It describes which settings define the initial behavior of the app, how those settings are ordered by likely human use, and why the state object intentionally excludes bulky raw playlist text.
GET Parameters
GET Parameters explains how the application state can be reproduced or partially controlled through URL query variables. It also explains the naming conventions, the removal of underscore characters, and the rule that GET variables are case-insensitive even when shown in a visually capitalized form.
Local File Mode
Local File Mode explains the special behavior of the application when it runs directly from file:// on a local computer. It clarifies which features still work normally, which browser or platform restrictions may apply, and why some media providers such as YouTube disable embedded playback in this mode.
Remote Playlist Loading
Remote Playlist Loading explains how the app loads plain UTF-8 playlist files from remote servers and what those servers must do for local and hosted builds to access them correctly. It is especially useful for users working with public playlist URLs, CORS behavior, and cloud hosting.
Output Resolutions and Aspect Ratios
This document explains the meaning of the Output Resolution and Aspect Ratio controls, including how the resolution menu is sorted by X dimension and why business cards, postcards, and screen outputs may all appear together in a single human-readable list.
Export / Reproduction
Export / Reproduction explains how to capture the current interface state in a way that can be shared, saved, or manually reconstructed later. It covers the exported GET string, the JavaScript state object, and the limits of reproducing a session when playlist edits exist only in memory.
FAQ
FAQ collects recurring practical questions, short answers, and clarifications for users who want direct help with common situations without reading the longer conceptual documents first.
Version Notes
Version Notes explains how each release identifies itself, where release notes appear in the file and interface, and how users can verify exactly which build they are testing or reporting on.
Best next step
Upload the current docs tree zip.
Then I’ll do two things in order:
First
Extract the current document names and identify:
Second
Produce a clean proposed English doc architecture with:
-
new filenames
-
index structure
-
short descriptions
-
paragraph summaries
-
starter stub contents
Then we can rebuild the tree cleanly around that.