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

add 'ZIP' clarification and other editorials #55

Merged
merged 8 commits into from
May 18, 2020

Conversation

zhangyongjing
Copy link
Contributor

@zhangyongjing zhangyongjing commented May 8, 2020

to address ISSUE#39 and improve the text.

@QingAn @ShourenLan @xfq @zhiqiangyu

Copy link
Member

@xfq xfq left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM in general. We also need to specify whether features in ZIP like encryption are allowed, but I'm OK with specifying that in a future PR.

specs/packaging/index.html Show resolved Hide resolved
specs/packaging/index.html Outdated Show resolved Hide resolved
@zhangyongjing
Copy link
Contributor Author

Conflicts solved, pls proceed...

<h2>app</h2>
<p>app manages all MiniApp pages and global data, as well as MiniApp’s lifecycle management. It contains logic (app.js), configuration (manifest.json) and css (app.css).
</p>
<h2>root files</h2>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think "root directory" is better than "root folder".

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

actually, I put 'files' instead of 'folder' since there is no such 'root' folder (or directory) per se.

<p>page represents each of MiniApp pages, responsible for MiniApp page display and user interaction. It contains logic (page.js), configuration (page.json), structure (page.xml) and css (page.css).
<h2>pages</h2>
<p>
The <code>pages</code> folder contains sets of files for the display and user interaction of all MiniApp pages. Each set of files that shares the same base file name (e.g. 'page1') with different extension names describe a particular page on different aspects, such as the service logic (e.g. page1.js), the configuration (e.g. page1.json), the structure (e.g. page1.xml) and the style (e.g page1.css). Developers can choose to put all page files directly under the <code>pages</code> folder in a flat manner, or organize them in different sub-folders for different pages.
Copy link
Member

@xfq xfq May 14, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think "directory" is better than "folder" here, since "directory" is a file system concept, and "folder" is the graphical user interface metaphor that is used to represent a directory. (Same below.)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can agree to change 'folder' as 'directory'.

@zhiqiangyu zhiqiangyu merged commit c7cfb2e into w3c:gh-pages May 18, 2020
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

Successfully merging this pull request may close these issues.

3 participants