search

microsoft / win32-app-isolation

Tools and documentation for Win32 app isolation
MIT License
1.28k stars 33 forks source link

Add Packaging and Consent .md pages #1

Closed lilybarkley-msft closed 1 year ago

tiangao-ms commented 1 year ago

Hi Lily, could you put the files to docs/fundamentals/consent.md and docs/packaging/<somthing_appropriate>.md? I'd like to create the structure, but git does not allow empty folders, so we have to create the structure on the go.

lilybarkley-msft commented 1 year ago

Hi Lily, could you put the files to docs/fundamentals/consent.md and docs/packaging/<somthing_appropriate>.md? I'd like to create the structure, but git does not allow empty folders, so we have to create the structure on the go.

Sure thing, I renamed packaging to MSIX-Packaging-Tool.md since you can do this manually, but the document was showing how to use the tool

tiangao-ms commented 1 year ago

Sure thing, I renamed packaging to MSIX-Packaging-Tool.md since you can do this manually, but the document was showing how to use the tool

Sorry if I'm not clear, could you move both folder under a folder docs in root? So create a directory named docs and put every tooling folder in it. In the future, we will have other stuff like tool executables, so we should collect all the documentations in a single directory.

docs |
  fundamentals |
    - consent.md
  packaging |
    - msix-packaging-tool.md
LICENSE
README.md
...

Also for file/directory names, it's totally fine to use capitalized words with dashes, but as we are trying to stick to a unified style, could you do all-lowercase-wth-dash? I know in root directory many files are ALL CAPS, that's a tradition for those specific root files on github. One of the reason to use lowercase is that it's easier for people to type and get auto-completions on systems that sensitive to cases. It's not a huge thing, we can go for the other way too, but sticking to a consistent style makes the project look better.